"该文档是关于项目代码风格的规范指南,涵盖了C#、XHTML、CSS和JavaScript四个方面的编码约定,旨在提升代码可读性和一致性。由张子阳编写,版本V1.0.20130605。"
在C#代码风格要求中,有几个关键点值得重视:
1. **不使用缩写**:这是为了增加代码的清晰度,避免因缩写导致的理解困难。即使是很常见的缩写如msg,也应当完整写出。
2. **代码使用半展开**:这意味着在编写代码时,应展开所有的控制结构,如if、for、while等,即使它们的内容只有一行。这样可以使代码更易读,更易于维护。
3. **使用Tab作为缩进**,并且设置缩进大小为4个空格。这有助于保持代码的对齐和视觉一致性。
4. **一个.cs源文件至多定义两个类型**,并且**类型名称和源文件名称必须一致**,这是为了保持代码组织的清晰和模块化。
5. **命名规范**:命名空间、类型名称遵循Pascal风格,即每个单词首字母大写。本地变量和方法参数则使用Camel风格,首字母小写,后续单词首字母大写。私有和受保护的方法依然使用Pascal风格,尽管这不是常规做法。
6. **if语句**:如果if语句内容只有一行,可以不加花括号,但条件和语句必须在同一行。而调用类型内部成员需加`this`前缀,调用父类成员需加`base`前缀。
7. **字段命名**:私有和受保护的字段使用Camel风格,但前缀一个下划线`_`。不应有公有字段,以确保封装性。
8. **成员排列顺序**、**委托和事件的命名**、**返回bool类型的方法、属性的命名**、**常见集合类型的后缀命名**、**常见后缀和类型命名**以及**字段和属性的命名**都有具体的规定,这些都旨在增强代码的可读性。
对于XHTML代码风格要求:
1. **层次对应**:代码结构应反映标记的层次关系,保持代码的结构性。
2. **所有标记必须闭合**:遵循XHTML的严格规则,确保每个标签都有相应的结束标签。
3. **长代码段注释**:如果标记间的代码超过20行,应在标记末尾添加注释标识,便于理解。
CSS代码风格要求:
1. **代码使用半展开**,与C#相同,提高可读性。
2. **使用Tab作为缩进,缩进大小同样为4**,保持格式统一。
3. **代码注释**:鼓励添加注释,以解释代码功能。
4. **样式比例**:嵌入式样式不超过10%,内联样式不超过30%,外联样式不少于60%,以优化样式管理并减少重复。
JavaScript代码风格要求:
1. **代码使用半展开**,同样是为了提高代码的可读性。
这些规定都是为了创建一致、整洁且易于维护的代码库,提高团队协作效率。