代码风格没有正确与否,重要的是整齐划一,这是我拟的一份《项目代码风格要求》,供大家参考。什么是好的注释:你写的代码别人能够很容易的看懂, 这才是好的注释, 命名规范, 代码设计良好。 这才是好的注释
1.方便代码的交流和维护。
2.不影响编码的效率,不与大众习惯冲突。
3.使代码更美观、阅读更方便。
4.使代码的逻辑更清晰、更易于理解。
在C#中通常使用的两种编码方式如下
Camel(驼峰式): 大小写形式-除了第一个单词,所有单词第一个字母大写,其他字母小写。
Pascal(帕斯卡): 大小写形式-所有单词第一个字母大写,其他字母小写。
1 C# 代码风格要求 11 注释
12 类型(类、结构、委托、接口)、字段、属性、方法、事件的命
13 不使用缩写
14 代码使用半展开
15 使用Tab作为缩进,并设置缩进大小为4
16 一个cs源文件至多定义两个类型
17 类型名称和源文件名称必须一致
18 所有命名空间、类型名称使用Pascal风格(单词首字母大写)
19 本地变量、方法参数名称使用Camel风格(首字母小写,其后
110 私有方法、受保护方法,仍使用Pascal风格命名
111 如果if语句内容只有一行,可以不加花括号,但是必须和if
112 调用类型内部其他成员,需加this;调用父类成员,需加base
113 类型内部的私有和受保护字段,使用Camel风格命名,但加“
114 不能出现公有字段
115 类型成员的排列顺序
116 委托和事件的命名
117 返回bool类型的方法、属性的命名
118 常见集合类型后缀命名
119 常见后缀命名
120 常见类型命名
121 常见字段、属性命名
2 XHTML 代码风格要求
21 如果XHTML标记有层次,那么代码也要有层次
22 所有标记必须闭合
23 如果标记中间代码超过20行,则应在标记末尾加注标识
3 CSS 代码风格要求
31 代码使用半展开
32 使用Tab作为缩进,并设置缩进大小为4
33 代码注释
34 代码编写
35 嵌入式样式的比例不超过样式表代码总量的10%
36 内联式样式的比例不超过样式表代码总量的30%
37 外联式样式表的比例不少于样式表代码总量的60%
4 JavaScript 代码风格要求
41 代码使用半展开
42 使用Tab作为缩进,并设置缩进大小为4
43 代码注释
44 不得出现内嵌式代码
45 内联式代码占JavaScript的总量不得超过40%
46 外联式代码占JavaScript的总量至少为60%