您的位置:首页 > 编程语言

规范你的代码编写风格

2018-03-04 17:09 162 查看
笔者寄语:一份编写规范的代码会让人赏心悦目,养成良好的代码编写习惯是每一个程序员应该具备的基本素养!
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开头

注:本篇博文为自己学习过程的心得笔记,如有内容雷同,还请见谅,谢谢!
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签:  代码编写风格