摘要:编程规范 设计规则 编程指导      参阅:概述

2 命名

名不正言不顺、顾名思义、名如其人;

可见命名之重要,我们在编码过程中,到处都会遇到命名,而多数人对命名草率处置,事实上糟糕的命名是烂代码的罪魁祸首,因此我们必须把命名上升到一个高度来认识。

2.1 命名的总则

简洁精确、名副其实、一以贯之、勇于重构

名字是对一个具体事务最简洁的陈述,它能够清晰的、如实地反映事务本身,不能词不达意,更不能张冠李戴,要认识到起一个好名字是不容易的,是需要思考和花时间的,但它会在后续的过程中跟你更多的回报。

名字要简洁,但必须意思完整,例如一个变量命名为Number,意思就不完整,是什么Number啊?我们许多程序员的程序中充满了类似的命名,半截子话,需要你猜。

好的名字一目了然,不需要读者去猜,甚至不需要注释

为了起名字更加规范、容易,要求各项目必须根据具体技术领域(解决方案领域)、业务领域(问题领域)制定详细的命名字典,全面明确的定义该项目中使用的全部名次、动词、形容词、动名词等,并制定各种事务的详细命名规范,项目组成员要根据命名字典和命名规范进行命名。

一个体系中每个概念只能唯一对应一个词,不要一意多词,也不要一词多意。

发现一个不好的名字就及时重构。

2.2 命名指导原则

类名:使用名词或名词短语,不能使用动词,要简洁明确,避免使用似是而非的词。如:

AccountInfo,AccountData,Info、Data到底是什么意思,有和区别不如就用Account。

我们的命名规范中规定类名前增加两到三个大写字母,用于表达类的归属,两个字母用于平台级,三个字母用于应用级,这有利于区别应用类和通用jar包的类,是好的办法,但必须事先制定好归属代码的规范。

方法名:使用动词或动词短语,属性访问器遵循JavaBean的标准(get、set、is)。

一个方法必须只做一件完整的、独立的事,名字必须精确表达该方法的具体行为,努力为方法起个好名字,有时你很难为一个方法起一个恰当的好名,往往表明两件事:

1)你对这个方法到底要做什么还不明确(设计有问题);

2)这个方法做的事情太多,违背了方法简单、独立的原则。

因此命名还会纠正设计问题,有关方法的问题我们在后面还会专题讨论。

方法名以小写字母开头。

属性名:使用名词、名词短语或动名词;

属性名是类下面的子概念,不必重复类名;

Java通行规范约定属性名以小写字母开头,我们规定以大写字母开头,这样即可以简单地识别属性名,在类似的赋值语句中略去讨厌的this.

this.Name = name;

Name = name;

变量和参数名:使用名词、名词短语或动名词;

除了循环变量和简短的数学运算可以采用单字母(或双字母)变量外,一律采用简洁且含义精确的名称,如:AccNo,我们推荐使用缩写,但必须使用统一一致的缩写规范。

循环变量可以使用i、j、k、n、m,避免使用l、o;

   项目、包、目录名:

一个系统可能会建立一个以上的项目、包和目录等,这些都涉及到命名,必须在如上的规则指导下,由总体组统一制定具体名称。

编程规则 - 2 命名规则相关推荐

  1. c语言程序的基本规范是什么,C语言编程规范——3 命名规则

    3 命名规则 3.1 命名的基本原则 标识符的命名要清晰.明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解--尽量采用采用英文单词或全部中文全拼表示 3.2变量名的命名规 ...

  2. python的命名规则_python命名规则

    广告关闭 腾讯云11.11云上盛惠 ,精选热门产品助力上云,云服务器首年88元起,买的越多返的越多,最高返5000元! 1.模块模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且 ...

  3. python文件命名规则-Python命名规则

    使用内容审核Python版本SDK包,需要您配置Python开发环境.从Python官网下载并安装合适的Python版本.兼容Python2.6+以及Python3.x.推荐使用Python3.x版本 ...

  4. java命名规则_Java命名规则

    Java命名规则 定义规范的目的是为了使项目的代码样式统一,使程序有良好的可读性. 命名规则: java源文件的命名 如果有public类,那么源文件名就是public类名,一个文件中只能有一个pub ...

  5. python中类的命名规则_python命名规则

    1. 以一个下划线开头的标识符(_xxx),不能访问的类属性,但可通过类提供的接口进行访问,不会被语句 "from module import *" 语句加载 2. 以两个下划线开 ...

  6. 软件版本号规则和命名规则

    1.  软件版本阶段说明 o    Base版: 此版本表示该软件仅仅是一个假页面链接,通常包括所有的功能和页面布局,但是页面中的功能都没有做完整的实现,只是做为整体网站的一个基础架构. o    A ...

  7. 变量命名规则_JavaScript基础教程(二)变量、常量与运算符

    常量变量与运算符 从本次课程开始我们将进入JavaScript基础教程学习,本课程附带PPT讲义,课程主要针对JavaScript学习入门者. 变量 在计算机程序设计语言中,变量是存储数据的容器,变量 ...

  8. JavaWeb 命名规则

    命名规范 命名规范命名规范 命名规范 本规范主要针对java开发制定的规范项目命名 项目命名项目命名 项目命名 项目创建,名称所有字母均小写,组合方式为: com.company.projectNam ...

  9. 2 ABAP命名规则

    2 ABAP命名规则 程序命名规则:<Z><XX><nnn> <Z> :项目上的开发程序以Z开头 <XX> :程序属于的业务模块(例如:MM ...

最新文章

  1. 南大电子机器人入驻云南_云南大学外语协会 英文歌曲演唱比赛
  2. 7000 界面语言不升级_仅限今日!手把手教你C++图形界面开发|附完整代码,海量干货!...
  3. Parse error: syntax error, unexpected T_PUBLIC in 问题解决
  4. Insertion Sort List
  5. 【性能优化】EKPO/EKBE和LIPS做JOIN的问题
  6. 二叉查找树的C语言实现(二)
  7. VTK:可视化算法之ColorIsosurface
  8. 跨域上传图片的尝试过程,最终成功了--- 转载
  9. FreeRTOS--API函数
  10. 19:Remove Nth Node From End of List【两指针】【链表】
  11. 如何只用一个小时定制一个行业AI 模型?
  12. sharepoint 2013 配件控制FileUpload如何检查是否图像的方法
  13. 【CASS精品教程】CASS绘图软件入门初级教程超详细资料
  14. 洛谷试炼场:单词接龙
  15. 5G 商用第三年:无人驾驶的“上山”与“下海”
  16. c语言中malloc的作用,malloc函数-malloc函数,详解
  17. 用计算机制作个人简历图片,计算机应用基础制作个人简历.ppt
  18. Unity.TimeLine
  19. 高德导航在天地图显示
  20. 通俗解释Docker

热门文章

  1. 【奇怪知识点】百事有雪碧吗?
  2. linux无线usb网卡,Linux下USB无线网卡WL-167G驱动安装过程
  3. Python程序开发
  4. ubuntu16.04 通过命令,修改屏幕分辨率
  5. 五层协议体系结构的各层功能
  6. html中td内容不换行显示,html小技巧之td,div标签里内容不换行
  7. windows下php包下载及环境配置
  8. 一篇文章彻底弄懂零拷贝底层原理
  9. 1.2.2 网络抓包工具之:Fiddler
  10. Mp3Player VS Diskman(1)