没有规矩不成方圆,.NET程序员在日常的工作中坚持良好的编码习惯,对于今后的代码维护以及交接工作都大有裨益。
1. 引言
本文是一套面向C# programmer 和C# developer 进行开发所应遵循的开发规范。
按照此规范来开发C#程序可带来以下益处:
·代码的编写保持一致性,
·提高代码的可读性和可维护性,
·在团队开发一个项目的情况下,程序员之间可代码共享
·易于代码的回顾,
本规范是初版,只适用于一般情况的通用规范,并不能覆盖所有的情况。
2. 文件组织
2.1 C# 源文件
类名或文件名要简短,不要超过2000LOC,将代码分割开,使结构清晰。将每个类放在一个单独的文件中,使用类名来命名文件名(当然扩展名是.cs)。这种约定会使大家工作更简单。
2.2 目录设计
为每一个命名空间创建一个目录。(用MyProject/TestSuite/TestTier作为MyProject.TestSuite.TestTier的路径,而不用带点的命名空间名做路径)这样可以更容易地将命名空间映射到目录层次划分。
3. 缩进
3.1 换行
当一个表达式超过一行时,根据这些通用原则进行处理:
·在逗号后换行。
·在操作符后换行。
·在高层换行而不要在低层处换行。
·折行后对齐上一行语句同一层的表达式起始位置。
方法调用换行示例:
longMethodCall(expr1, expr2, expr3, expr4, expr5); |