代码风格建议

1、代码风格一致,注意折行、缩进、空行、注释

2、对变量、宏、、枚举等进行注释

3、缩进最好不用tab,而是使用4个空格

4、单行注释最好不要与代码同行

5、对错误进行全局管理

6、引进需要的命名空间

7、使用预编译头文件,将自己写的头文件与系统头文件分开

8、有完整规范的日志输出,日志要有层次性

9、有些if判断后的返回可以用断言代替(断言:assert(expr),不满足条件即终止运行)

时间: 2024-11-16 07:25:34

代码风格建议的相关文章

Python代码风格建议(转)

python 以其结构严格著称,同时也以其命名规范散漫出名,算乱无规矩的命名尤其给开发人员带来理解上的误区. 尤其像python.ruby动态语言,由于在运行期随时可能出现方法或者属性的增减,规则的命名尤其重要. ruby语言本身定义的语法规则较为随意,但却不乏一一对应的隐含规则,使人一目了然.其命名规则甚至渗透进了语言本身的规范当中 在命名规则这一点上python显得没规没距.需要逐步养成一个好的编码命名规范. 本文从各大站点文章中搜集了一些代码风格,命名规范.便于学习参考. 代码风格: 使用

python代码风格指南:pep8 中文翻译

摘要 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见?PEP7.本文和?PEP 257 文档字符串标准改编自Guido最初的<Python Style Guide>, 并增加了Barry的?GNU Mailman Coding Style Guide的部分内容.本文会随着语言改变等而改变.许多项目都有自己的编码风格指南,冲突时自己的指南为准. 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见PEP7. 本文和PEP 257 文档字符串标准改

PSR代码风格指南

代码风格指南 本手册是基础代码规范(PSR-1)的继承和扩展. 为了尽可能的提升阅读其他人代码时的效率,下面例举了一系列的通用规则,特别是有关于PHP代码风格的. 各个成员项目间的共性组成了这组代码规范.当开发者们在多个项目中合作时,本指南将会成为所有这些项目中共用的一组代码规范. 因此,本指南的益处不在于这些规则本身,而在于在所有项目中共用这些规则. RFC 2119中的必须(MUST),不可(MUST NOT),建议(SHOULD),不建议(SHOULD NOT),可以/可能(MAY)等关键

编写更好的jQuery代码的建议

编写更好的jQuery代码的建议 2013/12/05 | 分类: WEB前端, 开发 | 15 条评论 | 标签: JQUERY 分享到:125 本文由 伯乐在线 - yanhaijing 翻译自 Mathew Carella.欢迎加入技术翻译小组.转载请参见文章末尾处的要求. 讨论jQuery和javascript性能的文章并不罕见.然而,本文我计划总结一些速度方面的技巧和我本人的一些建议,来提升你的jQuery和javascript代码.好的代码会带来速度的提升.快速渲染和响应意味着更好的

PSR-2 代码风格规范

这篇规范是PSR-1(基本代码规范)的扩展和继承. 本规通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 这个风格规范是从各种各样的项目的共性中延伸出来的.当多名程序员在多个项目中合作时,它有助于有一套准则,在所有的项目中使用. 因此,本指南的好处不是在规则本身,而是在这些规则的共享. 关键词 "必须"("MUST")."一定不可/一定不能"("MUST NOT")."

[转] Linux内核代码风格 CodingStyle [CH]

from:http://blog.csdn.net/jiang_dlut/article/details/8163731 中文版维护者: 张乐 Zhang Le <[email protected]> 中文版翻译者: 张乐 Zhang Le <[email protected]> 中文版校译者: 王聪 Wang Cong <[email protected]>                wheelz <[email protected]>        

Linux内核代码风格

这是一个简短的文档,描述了linux内核的首选代码风格.代码风格是因人而异的,而且我 不愿意把我的观点强加给任何人,不过这里所讲述的是我必须要维护的代码所遵守的风格, 并且我也希望绝大多数其他代码也能遵守这个风格.请在写代码时至少考虑一下本文所述的 风格. 首先,我建议你打印一份GNU代码规范,然后不要读它.烧了它,这是一个具有重大象征性 意义的动作. 不管怎样,现在我们开始: 第一章:缩进 制表符是8个字符,所以缩进也是8个字符.有些异端运动试图将缩进变为4(乃至2)个字符 深,这几乎相当于尝

编写高质量JAVA程序代码的建议

--------------------------------------------------------------------------------------------------- 前言:原著<改善JAVA程序的151个建议>有151个建议,我在拜读的过程根据自己的理解合并了其中的几个,并将每个建议的核心要义进行了一次纯手工提炼,以方便想阅读这本书的同行能够更快的掌握这本书的所有核心内容. -------------------------------------------

Css的三种常用代码风格

代码格式化的作用:代码更佳美观.容易理解和更好维护. 代码风格一: 主要包括以下特征: 选择符顶行书写. 每条声明单行显示并缩进4空格 规则之间可以适当空行,以便于阅读 属性与属性值之间,以及选择符列表之间建议空一格,使代码显得不至于拥挤. 代码风格二: 主要包括以下特征: 选择符顶行书写. 样式代码单行显示,所有声明都并列在一行内. 规则之间可以适当空行,以便阅读. 属性与属性值之间.声明之间,以及选择符列表之间最好空一格,便于阅读. 代码风格三: 主要包括以下特征: 选择符顶行书写. 当样式