规范你的代码编写风格

笔者寄语：一份编写规范的代码会让人赏心悦目，养成良好的代码编写习惯是每一个程序员应该具备的基本素养！

1、基本规则

【规则1-1】标识符应当直观且可以拼读，可望文知意，不必进行“解码”。

例如：标识符最好采用英文单词或其组合，便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂，用词应当准确。例如不要把CurrentValue写成NowValue。

【规则1-2】标识符的长度应当符合“min-length && max-information”原则。

【规则1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。

　例如Windows应用程序的标识符通常采用“大小写”混排的方式，如AddChild。而Unix应用程序的标识符通常采用“小写加下划线”的方式，如add_child。别把这两类风格混在一起用。

【规则1-4】程序中不要出现仅靠大小写区分的相似的标识符。

【规则1-6】变量的名字应当使用“名词”或者“形容词＋名词”。

【规则1-7】全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。类的成员

函数应当只使用“动词”，被省略掉的名词就是对象本身。

【规则1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

【建议1-1】尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。

2、简单的Windows应用程序命名规则

【规则2-1】类名和函数名用大写字母开头的单词组合而成

【规则2-2】变量和参数用小写字母开头的单词组合而成。

问：对象和结构体成员命名规则？

【规则2-3】常量全用大写的字母，用下划线分割单词。

【规则2-4】静态变量加前缀s_（表示static）。

【规则2-5】如果不得已需要全局变量，则使全局变量加前缀g_（表示global）。

【规则2-6】类的数据成员加前缀m_（表示member），这样可以避免数据成员与成员函数的参数同名。

【规则2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头，所有常量（或宏定义）均以GL开头。

项目经验：

1、所有vector类容器命名在最后都加上Gather,set类容器命名最后面都加上Set

2、结构体变量以t开头

3、指针以p开头

4、临时变量以temp开头

注：本篇博文为自己学习过程的心得笔记，如有内容雷同，还请见谅，谢谢！

规范你的代码编写风格相关推荐

《Java和Android开发实战详解》——2.5节良好的Java程序代码编写风格
本节书摘来自异步社区<Java和Android开发实战详解>一书中的第2章,第2.5节良好的Java程序代码编写风格,作者陈会安,更多章节内容可以访问云栖社区"异步社区&quo ...
VHDL+Verilog良好的代码编写风格(转载)
良好代码编写风格可以满足信.达.雅的要求.在满足功能和性能目标的前提下,增强代码的可读性.可移植性,首要的工作是在项目开发之前为整个设计团队建立一个命名约定和缩略语清单,以文档的形式记录下来,并要求每 ...
良好的代码编写风格（二十五条）
良好代码编写风格可以满足信.达.雅的要求.在满足功能和性能目标的前提下,增强代码的可读性.可移植性,首要的工作是在项目开发之前为整个设计团队建立一个命名约定和缩略语清单,以文档的形式记录下来,并要求每 ...
对于‘用C#编写一个员工工资计算’问题的代码编写风格和结构设计考虑的比较【发现自己还是太弱,大家可以在评论区中提出我代码中的不足】
目录 1.'用C#编写一个员工工资计算'问题描述 2.个人思考和实现 2.1代码实现: 2.2调试结果及保存txt内容: 3.他人的实现 3.1代码实现: 3.2保存的txt内容: 1.'用C#编写一 ...
vuejs中组件的两种不同的编写风格-选项式API及组合式API
前言随着vue3的逐渐稳定,以及周边生态的完善,现在vue3已经成为默认的使用方式了的所以,对于一个前端开发者,Vue2与Vue3都得要会,在vue3中新增很多东西,比如:Fragment,Tel ...
C语言程序代码编写规范
前言一个好的程序编写规范是编写高质量程序的保证.清晰.规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证软件的质量和可维护性. 说明 l 本文档主要适用于刚刚开始接 ...
c语言程序前言,C语言程序代码编写规范前言
该楼层疑似违规已被系统折叠隐藏此楼查看此楼一个好的程序编写规范是编写高质量程序的保证.清晰.规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证软件的质量和可维护性 ...
c语言程序报告的前言,C语言程序代码编写规范前言
该楼层疑似违规已被系统折叠隐藏此楼查看此楼一个好的程序编写规范是编写高质量程序的保证.清晰.规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证软件的质量和可维护性 ...
WEB应用程序UI模版代码编写及使用规范
WEB应用程序UI模版代码编写及使用规范 2011-05-16 来源:网络这是去年在中软时做的一个UI模板规范,有很多我的经验,在做B/S版应用程序时比较适用,其实这样的东西算不上什么正规的 ...

规范你的代码编写风格

规范你的代码编写风格相关推荐

最新文章

热门文章