C#编码良好习惯的养成

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.