编码命名原则

标题：编码命名原则
作者：kagula(lee353086)
最后修订日期：2008-03-18
首发日期：2008-01-16
修订次数：1

内容：
      命名规则列表。原则上，也适用于C++

目的：
      形成固定的编码风格，方便以后代码维护。也适用于其它类Java高级计算机语言。
     
正文：

[a]语言中概念命名原则：
  [a-1]总的命名原则：
    [a-1-1]一致性原则。

  [a-2]类名：大写ASCII字母开头
    [a-2-1]代表表单类(持久层)数据对象的类名，以CTable开头，后跟第一个字母大写的类名。
    [a-2-2]代表窗口类对象的类名，以CWin开头，后跟第一个字母大写的类名。 
    [a-2-3]代表主程序类对象的类名（每个软件中最多只有一个），以CApp开头，
           后跟第一个字母大写的类名，也可不跟。
    [a-2-4]代表框架的类名（每个软件中可以有多个），以CFrame开头，后跟第一个字母大写的类名
    [a-2-5]数据容器类
           Map型数据容器：以CMap开头，后跟第一个字母大写的类名。
           List型数据容器：以CList开头，后跟第一个字母大写的类名。
           Set型数据容器：以CSet开头，后跟第一个字母大写的类名。
           Stack型数据容器：以CStack开头，后跟第一个字母大写的类名。
           还有很多种数据容器，可依此类推。

  [a-3]方法名（或函数名）：小写ASCII字母开头，第二个单词的第一个字母需大写。
       方法名结构：([get|set|do|send|post]|[])(方法名)
       若还有前缀，方法名以大写字母开头
       get  取当前对象属性的方法;例如：getAttribute();
       set  设当前对象属性的方法;例如：setAttribute(int nInt);
       do   以异步方式，执行对象的成员方法;例如:doOperation();
            其中Operation为，对象的方法名。
       send 同do一样，要求对象，以同步方式，完成某项操作;例如:sendMessage(消息);
            形参表中的消息，指的是，要求对象完成的某项操作，可以是个形参表。
       Post 类似send，但是要求对象，以异步方式，完成某项操作;例如:postMessage(消息);
            形参表中的消息，指的是，要求对象完成的某项操作，可以是个形参表。
       空   代表对象的一个同步操作，或函数名。

  [a-4]变量(或常量或其它类型的最小操作对象)名：
    [a-4-1]全局变量
       变量名结构：(g_)(变量类型缩写)(变量名)
    [a-4-2]全局常量
       变量名结构：(G_)(变量类型缩写)(_)(变量名)
       全部大写
　　[a-4-3]局部变量 对象的公有变量
      [a-4-3-1]对象的公共成员变量
        变量名结构：(变量数据类型缩写)(变量名)
        变量名的第一个字母需大写。
      [a-4-3-2]对象的受保护成员变量
        变量名结构：(m_)(变量数据类型缩写)(变量名)
        m_ 成员(仅适用于protected存取方式);例:m_member
      [a-4-3-3]对象的私有成员变量
        规定，同上条
      [a-4-3-4]过程变量（作用域在一个过程中的变量）
        变量名结构：(变量名)[序号]
        第一个单词需小写。
        也可采用小写缩写，例：
        SpringFrameDao sfd=new SpringFrameDao();  //其中sfd为SpringFrameDao的小写字母缩写。
             sfd代表SpringFrameDao的实例。如果要求有多个该实例，可以添加[序号]，例：
　　　　　　 sfd1、sfd2等等。　
      [a-4-3-5]对象成员的常量（以及过程中的常量）
        变量名结构：(变量名)
        名字需大写
      [a-4-3-6]一些特殊变量
        [a-4-3-6-1]static存储类型的变量
        变量名结构：(static)(变量名)
        变量名的第一个字母需大写
        [a-4-3-6-2]指针变量(或参数表中的形参)
        建议，变量名前追加一个小写ASCII码p,后跟第一个字母大写的变量名

[b]代码段编码原则
  [b-1]每个代码段（体），长度下限至少二行，上限不超过百行。
　[b-2]整个软件域中，不应出现，重复次数超过两次的代码段。
  [b-3]每个代码段，应有输入、输出说明。
  [b-4]代码段之间的接口应尽可能简洁，即低耦合，高内聚。

[c]变量类型缩写表
  整型 int
  字串 str
  对象 obj
  映射机制的数据容器 map
  列表机制的数据容器 list
  集合原理的数据容器 set

[d]变量名
  可以是英文单词或缩写，也可以是拼音。但是在一个文件中，变量名，要么全部用英文单词缩写，要么全部用拼音。

[e]序号
   序号为一有限位数的正整数。

备注：
   [1]小括号，代表必选项，中括号，代表可选项。大括号，代表里面是一个集合操作。|代表集合的或运算符。
   [2]代码段：能完成某个独立功能的代码段，在逻辑(或物理)上有自己的存储作用域。

修改记录：
   [1]修改时间20080318:确定本文件的主要内容,为命名规则约定。对一些命名规则做了进一步细化。