C#编码好习惯小总结

发布时间：2023-06-14 09:30:17 所属栏目：语言来源：转载

导读： 　　C#编码好习惯小结

　　1. 避免将多个类放在一个文件里面。

　　2. 一个文件应该只有一个命名空间，避免将多个命名空间放在同一个文件里面。

　　3. 一个文件最好

　　C#编码好习惯小结

　　1. 避免将多个类放在一个文件里面。

　　2. 一个文件应该只有一个命名空间，避免将多个命名空间放在同一个文件里面。

　　3. 一个文件最好不要超过500行的代码（不包括机器产生的代码）。

　　4. 一个方法的代码长度最好不要超过25行。

　　5. 避免方法中有超过5个参数的情况。使用结构来传递多个参数。

　　6. 每行代码不要超过80个字符。

　　7. 不要手工的修改机器产生的代码。

　　a) 如果需要编辑机器产生的代码，编辑格式和风格要符合该编码标准。

　　b) Use partial classes whenever possible to factor out the maintained portions.

　　8. 避免利用注释解释显而易见的代码。

　　a) 代码应该可以自解释。好的代码由可读的变量和方法命名因此不需要注释。

　　9. Document only operational assumptions, algorithm insights and so on.

　　10. 避免使用方法级的文档。

　　a) 使用扩展的API文档说明之。

　　b) 只有在该方法需要被其他的开发者使用的时候才使用方法级的注释。（在C#中就是///）

　　11. 不要硬编码数字的值，总是使用构造函数设定其值。

　　12. 只有是自然结构才能直接使用const，比如一个星期的天数。

　　13. 避免在只读的变量上使用const。如果想实现只读，可以直接使用readonly。

　　public class MyClass

　　{

　　   public readonly int Number;

　　   public MyClass(int someValue)

　　   {

　　      Number = someValue;

　　   }

　　   public const int DaysInWeek = 7;

　　}

　　14. 每个假设必须使用Assert检查

　　a) 平均每15行要有一次检查(Assert)

　　using System.Diagnostics;

　　object GetObject()

　　{…}

　　object obj = GetObject();

　　Debug.Assert(obj != null);

　　15. 代码的每一行都应该通过白盒方式的测试。

　　16. 只抛出已经显示处理的异常。

　　17. 在捕获(catch)语句的抛出异常子句中(throw)，总是抛出原始异常维护原始错误的堆栈分配。

　　catch(Exception exception)

　　{

　　   MessageBox.Show(exception.Message);

　　   throw ; //和throw exception一样。

　　}

　　18. 避免方法的返回值是错误代码。

（编辑：晋中站长网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!