文件组织
--------------
为每一个类建一个新文件，以类名作为文件名，不包含实际逻辑的类以及自动生成的类可以除外。
为每一个命名空间建一个新目录，目录名为命名空间的名字。
不要把第三方提供的代码与自己的代码混合在一起。
代码与其unit测试代码放在同一namesapce下面，同一文件里。
基本
---------------
代码太长时，在逗号或者运算符后换行，换行时不要打乱运算的逻辑，新行与上一行的被断开的表达式对齐。
缩进用tab，避免用空格。
保持代码排版清晰。
if-else；for/foreach ；while/do-while；switch；try-catch等按照visual studio IDE的默认风格。
逻辑独立的代码块之间用空行分割。
一行代码中，逗号、分号等分隔符后面应该加空格改善可读性，运算符，冒号应该前后都加空格或者都不加。
一元运算符以及自增，自减，[]，()与运算数之间不要加空格
用#region #endregion将类的成员分组。
从函数返回一个值不要用括号。
注释
-----------------
注释应该与被注释的代码处于相同的缩进级别，并且位于代码的前一行。
一般来说，注释不应该多于代码，如果需要大块的注释，使用c#的标准格式 ///，不要使用//-------------------之类的格式。
对于类，方法，接口的注释使用C#标准的xml格式 （Documentation Comments）
xml标示说明:
<summary>说明
<remarks>附加信息，比如前提条件
<param> 函数参数
<returns>函数返回值
<exception>可能抛出的异常
<value>属性方法可以接受的值的类型或者函数返回值的类型
<example>示例
<seealso>相关的其他成员
<overloads>重载列表（位于重载列表中的第一个函数前）
<see>
<paramref>
<code>
<c>
<para>
<list>
<b>
<i>
变量，类，接口，函数
----------------------------------------------------------------
每行定义一个变量，尽量在定义变量时赋初始值
类的私有变量以及公共变量定义在类的开始，先定义私有变量，再定义公共变量。
打印 | 张贴于 2004-04-15 20:27:00 | Tag:暂无标签
留言反馈