代码规范-命名

Posted just-save

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了代码规范-命名相关的知识,希望对你有一定的参考价值。

  • 命名的原则:

1能够完全而又准确的体现变量所代表的事物,不能有模糊性,比如a,b,也不要使用拼音缩写(还拼错了的你够了orz),完全而又精确,意思是代码的目的信息不能少,但是也不能有废话

2易于阅读,维护,我们交流的对象是人类,不是计算机

3我们的目的是写出可维护,可读性高的代码,无需也不可执着于某种方法,要根据实际情况来

4要形成自己独特的代码风格,但是做项目时要与项目中的风格保存一致

5遵守具体语言的代码规范

5当看到一个变量时,我们要知道,这段代码是干什么的?编码者的目的是什么的?

6尽量不要太长(orz)

  • 几种命名方法:

1小驼峰命名法:首字母小写,其他单词首字母大写,常用于变量命名,如myFirstName,

2大驼峰命名法(帕斯卡命名法):所有单词首字母均大写,常用于类,函数等,如MyFirstName,

3匈牙利命名法:把数据类型加在名字中

4下划线命名法:单词间用下划线隔开,如my_first_name

  • 一些命名心得:

1为变量加上数据类型前缀,如g_varName,便于识别变量的类型

前缀参考:

c                             数量
first         数组中需要处理的第一个元素。针对当前操作而言的第一个元素
last         数组中需要处理的最后一个元素,与 first 相对应
g            全局变量
i             数组的下标
lim   l      im表示的是一个数组中并不存在的上界,lim 等于 last + 1
m           类一级的变量
max       数组或其他种类的列表中绝对的最后一个元素,反映的是数组本身
min        数组或其他种类的列表中绝对的第一个元素,与max相对应
p            指针

2变量中尽量不要使用下划线,变量使用小驼峰,类,函数使用大驼峰

3给变量缩写时,可以参考:去掉非前置元音,保留单词第一个和最后一个字母

4尽量不要使用数字,尽量不要使用相似的字符,如l和1,0和o,2和z,G和6,S和5等,避免混淆

5顺应常用而普遍的用法,如循环变量直接使用i,j,k 就行,n作为数量,异常处理使用e

6尽可能使用英文描述,如果不知道,要么查字典,或者使用命名网站

eg:https://unbug.github.io/codelf/

7如果不知道自己的命名如何,那么将命名给别人阅读试试,看对方的想到的与你的目的是否一致,寻求别人的意见

8学习大型项目中别人的命名法,大公司中已经对这些要求很高并且有了一定的规范

 

未完待续。。。。

  • 参考:

0:https://blog.csdn.net/AndyNikolas/article/details/54773529

1:https://zhuanlan.zhihu.com/p/24286730

2:https://www.zhihu.com/question/21440067

3:https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/naming/

4:https://www.zhihu.com/question/27097399

以上是关于代码规范-命名的主要内容,如果未能解决你的问题,请参考以下文章

GO 编码规范

编码规范篇| C#编码规范 代码规范总结,包括命名规范,代码规范 注释规范等

PHP 代码规范流程规范git规范

10分钟了解代码命名规范(JavaPython)

工程代码规范和更新规范

JAVABEAN命名规范