代码规范-命名

  • 命名的原则:

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

原文地址:https://www.cnblogs.com/just-save/p/11625864.html

时间: 2024-10-10 21:33:06

代码规范-命名的相关文章

C/C++ 代码规范: 命名规则、注释、格式

摘抄精简Google 开源项目风格指南: http://zh-google-styleguide.readthedocs.org/en/latest/contents/ 一. 命名规则 永远不要使用单词缩写(如count写成cnt) 变量名: 小写字母,下划线连接,一般用名词,如error_count 类的成员变量以下划线结尾,如my_exciting_member_variable_ 结构体的数据变量,小写字母,下划线连接 全局变量,前缀g_ ,如g_global_variable 常量: 加

小白学js第六天之代码规范,作用域以及预解析

目录 代码规范 命名规范 变量规范 注释规范 空格规范 换行规范 作用域 全局变量 局部变量 块级作用域 作用域链 预解析 什么是预解析 变量提升 此篇木有脑图,嘻嘻 代码规范 命名规范 变量.函数的命名必须要有意义 变量一般用名词 函数一般用动词 变量规范 操作符前后要有空格 var name = 'zs'; 注释规范 // 这里是注释 空格规范 if (true) { } for(var i = 0; i < n; i++ ) { } 换行规范 var arr = [1, 2, 3, 4];

IOS中Objective-C代码及命名规范

想做一名ios开发工程师,代码命名不规范是一种不专业的表现,因为ios开发工程师们学出来的代码会给很多人看,为了使代码清晰简洁,方便阅读理解,都会统一遵从一定的代码规范,Objective-C同样如此. 简单总结一下目前接触到的: 1.代码行度最大为100列(C++的是80) 2.声明类或方法时,注意空格的使用,参数过多时可换行保持对齐,调用方法时也是如此,参数都写在一行或换行冒号对齐. 3.命名规则 类名首字母大写,方法首字母小写,方法中的参数首字母小写,同时尽量让方法的命名读起来像一句话,能

两人合作之代码规范

代码规范 现代软件经过几十年的发展,一个软件由一个人单枪匹马完成,已经很少见了,软件都是在相互合作中完成的.合作的最小单位是两个人,两个工程师在一起,做的最多的事情就是"看代码",每个人都能看"比人的代码",并且发表意见.但是每个人对于什么是"好"的代码规范未必认同,这时我们有必要给出一个基准线-----什么是好的代码规范和设计规范. 1,写干净整洁的代码 1.1 代码格式化,包括多级代码缩进.大括号(比如C系代码),为了提高代码的美观型和易读性

最详细的 Swift 代码规范指南

1. 代码格式 1.1 使用四个空格进行缩进. 1.2 每行最多160个字符,这样可以避免一行过长. (Xcode->Preferences->Text Editing->Page guide at column: 设置成160即可) 1.3 确保每个文件结尾都有空白行. 1.4 确保每行都不以空白字符作为结尾 (Xcode->Preferences->Text Editing->Automatically trim trailing whitespace + Incl

项目经理的管理技巧-代码规范

一.系统里面存在的糟糕代码情况有: 1. 代码规范,命名规范和注释 2. 公用代码的抽取和封装 3. 性能低下的代码 4. 表现层.业务层.数据持久层位置存放混乱问题 二.问题 岗位调动,接手一个新的项目组.旧项目一踏糊涂,全部无规范和设计. 组成员各做各的,毫无团队协作能力,更别说团队凝聚力.简直不能更糟糕. 新项目.新成员,新项目重新做了明确规范和框架设计,但组员很多时候不能很好的按照规范进行开发 我有强迫症  三.开始犯的错误,也是最笨的做法 定时核查,自己看到不正确代码同时指出,让开发优

软件工程第二周作业:代码规范和代码复审

0x01 :代码规划的要求 Q:这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西.(反驳) 首先,我们需要明确编码规范的定义,编码规范同时包括了编码风格和其它规范(代码设计上的规范,如设计模式.程序设计.模块之间的逻辑关联等). 编码风格,牵扯到“缩进.空格使用.注释.命名习惯”等多方面的因素,是依致特定编程语言制定的软件工程开发的“约定”,而相同的编码风格,可以使得软件开发过程中轻松浏览任意一段代码,充分保证不同的开发人员能够依据统一的编码格式轻松理解代码的逻

代码规范及代码复审

1.对代码规范的讨论 编写一个程序是否需要代码规范?本人以为,规范当然得有,但也必须合理. 为什么我们需要代码规范?代码规范就是规定代码中某些格式必须遵守一定条件,比如缩进.变量命名.注释等.当制定了合理的规范后,不仅代码本身会显得美观,而且每个人都很容易读懂,代码的可维护性也大大增强.举个例子,甲程序里使用的变量名有input_msg,output_msg,decipher,每个符号之间均加了空格,而乙程序里则是随意地使用a,b,c等无意义的字母作为变量名,而且多个函数里重复使用相同名称的局部

css代码规范问题重要的有几个

很多人刚开始接触的时候都会遇到很多困难,其中规范的书写格式也较为明显:今天为大家带来一些CSS代码规范的知识. 1.良好的命名规范 ID和class的命名尽可能短,并符合语义.多个单词的拼接用 '-' 符号链接,尽量使用小写字母. 2.代码缩写 CSS代码缩写可以提高你写代码的速度,精简你的代码量. li{font-family:Arial, Helvetica, sans-serif; font-size: 1.2em; line-height: 1.4em; padding-top:5px;