最近在为公司编写c#编码规范,以前对这方面研究不多,只是觉得代码能够出自己的意思就可以了。
我参考了以下资料
- NET设计规范约定惯用法与模式(第2版)
- 编写可读性代码的艺术
- 重构—改善既有代码的设计
- 高效程序员的45个习惯
- 代码整洁之道
发现其实真要写好一个代码规范是一件非常难的事情,这取决于规范制定者的经验,团队成员的水平,业务的具体需求,项目的复杂度,项目的进度,企业的文化氛围等等。
而且每次提笔要写的时候,总是有很多很多的想法想写进去,可是作为一个规范又不可能太长,要精简。
这是目前打算写的章节
1.命名规范
1.1 命名约定篇
1.2 命名选择篇
1.3 特定场景下的命名最佳实践篇
2. 注释
2.1 注释约定篇
2.2 不需要的注释篇
2.3 需要的注释篇
2.4 如何写好注释
3. 格式
4. 文档下载 & 总结
后续几天我会陆续的把后续章节写好,同时也希望大家帮我想想编码规范还有哪些方面需要覆盖。
整个编码规范写完后我会提供给大家一个完整的word文档。
现在把文章列出来是希望大家一起讨论下文档中是否有不合理的内容,还有哪些内容需要覆盖。