项目命名规范.doc

投稿: 下一秒 更新: 2021-08-07 浏览: 3次
侵权违规举报

内容介绍

项目命名规范 , 开发必备。
欢迎下载!
命名规范制定意义 1方便代码的交流和维护,便于日后自己的再次阅读。
2不影响编码的效率,不与大众习惯冲突。
3使代码更美观、阅读更方便。
4使代码的逻辑更清晰、更易于理解 命名规范制定原则 首要原则 有意义的,描述性的词语来命名。
能够一眼看出它作什么。
别使用会引起误解的名字。
如果名字一目了然,就无需用文档来解释方法的功能了 1.除约定俗成的,别用缩写。
用name,address,salary等代替nam,addr,sal 2.除用于循环,别使用单个字母的变量象i,n,x等.而要使用index,temp等。
for(inti=0;i比如:使用名称amount,而不是intAmount; ?类:使用名词、名词短语命名。
比如:publicclassFileStream; ?方法:使用动词、动词短语开始。
比如:CreateUser(),RemoveAt()等; ?接口:以I开始,后面加上名词、名词短语、形容词命名。
比如:IDisposable; ?常量:所有单词大写,多个单词之间用"_"隔开。
publicconststringPAGE_TITLE="Welcome"; ?命名空间:基本格式:    CompanyName/ProjectName.TechnologyName[.Feature][.Design]    a)CompanyName/ProjectName:公司名、项目名称或产品名称;    b)TechnologyName:稳定的、公认的技术名称或架构层次名称;    c)[.Feature][.Design]:可选的功能与设计; 规范
1、用pascal规则来命名方法和类.(
第一个单词首字母大写,后面连接的每个单词首字母都大写) publicclassDataBase;publicvoidGetDataTable()
2、类:使用名词、名词短语命名。
比如:publicclassFileStream; 2.用camel规则来命名局部变量和方法的参数.(
第一个单词不大写,后面连接的单词首字母大写) publicvoidAddUser(stringuserId,byte[]password) {stringuserName;} 3.所有的成员变量前加前缀_ publicclassDatabase {privatestring_connectionString;} 4.接口的名称加前缀I interfaceICompare {intcompare();} 5.自定义代码属性类以Attribute结尾 publicclassOperationAttribute:Attribute 6.自定义的异常以Exception结尾 publicclassAppException:Exception 7.方法的命名.一般将其命名为动宾短语,"动词+对象". GetRecordData();GetPath();CreateFile(); 8.代码的缩进.要用Tab,而不要用space. 9.使用带有说明性的变量名。
  (a)避免单字符串的变量名,使用类似于index或temp这样有意义的名字。
  (b)对于public或protected类型的变量避免使用匈牙利表示法。
  (c)不要缩写单词。
10.所有的类成员变量应该被声明在类的顶部,并用一个空行把它们和方法以及属性的声明区分开

下载地址

进入下载页
文件大小
69.0KB
上传作者
下一秒
文件类型
.doc

健康绿色上网,共建和谐网络环境,禁止发布任何违法信息