常用语言编程规范
以下常用编程命名规则是本人参考《代码大全第二版》,总结的适合自己的命名规则。
通用
- 变量名9-15个单词
- 做到望文知义
- 避免使用多义词或者模糊的词
- 正确使用对仗词
add/remove
begin/end
create/destroy
first/last
get/set
insert/delete
lock/unlock
min/max/
old/new
open/close
show/hide
source/target
start/stop
up/down
next/previous
- 循环下标
范围较小(临时)的循环可以使用
i,j,k
;对于有实际意义的循环下标下标,多使用index
做后缀
- 常用的布尔变量命名
done
error
success/ok
available
found
complete
少用is
MFC
书写MFC时,尽量按照微软的推荐命名规范。
C++
命名
- 工程命名: 多个单词组合,各单词首字母都大写 MyProject
- 文件命名: 多个单词组合,各单词首字母都大写 MyExemple.cpp MyExemple.h
- 类名/名称空间名:首字母大写,多个词组合起来,使用名词或名词词组 User MyClass
函数名:小写,多个字母组合使用下划线隔开,使用动词或动词词组,避免使用孤立的全局函数,可以封装在类或名称空间里面;常用前缀get,set,is.如: love_you(), set_name()
变量名:多个单词组合,各单词小写,使用下划线隔开 Student stu_a
- 常量: 全部大写,下划线分隔各个单词。 如: MAX_VALUE
代码书写
空格的使用
- 像
if、else if、for、while、switch
等关键字之后应留一个空格再跟左括号(
,以突出关键字 ,
之后要留空格,如fun(x, y, z)
- 如果
;
不是一行的结束符,则后面也要留空格,如for(initialization; condition; update)
- 二元运算符
= += + - * & % << && || >>
前后都要有空格, 一元运算符不用加空格,三元运算符? :
要加空格 - if语句严格按照上一条运算符加空格的原则加空,
if( a == b)
- for()语句只在
;
后加空格,中间语句运算符前后不用加,for(int i=0; i<length; i++)
Java
- 工程名: 各个单词首字母大写
- 类名:各个单词首字母大写 ExampleClass
- 成员变量:第一个单词首字母小写,其余单词首字母大写
- 方法: 第一个单词首字母小写,其余单词首字母大写,动词开头
- 常量: 全部大写,下划线分隔各个单词。 如: MAX_VALUE
HTML CSS
- id名:多单词组合,各单词首字母均大写
- class名:多单词组合,各单词首字母均大写
- 函数名:多单词组合,第一个单词首字母小写,其余单词首字母大写
并非最终版本,日后补充完善。