找回密码
 注册
搜索
热搜: java php web
查看: 616|回复: 0

java命名规范

[复制链接]
发表于 2009-1-28 00:35:13 | 显示全部楼层 |阅读模式
java命名规范最近注意到很多学生在命名上忽略了好多细节,网上关于命名规范的文章也不少,整理了一下供大家参考。

好的命名规范可以让你的程序更专业,更容易被别人理解,更好维护,增加可读性,减少项目组中因为换人而带来的损失。任何一个软件,几乎都不是由最初的开发人员来维护,在软件的生命周期中,大部分的花费在于维护。编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码。但是很多学生往往不会注意这些,他们只想着做好自己的一部分,自己明白就行了,不去管以后是不是会有人看,在这里java私塾提醒大家,习惯是慢慢养成的,在平常学习中就要坚持好的习惯不要怕麻烦,希望来java私塾学习的同学们都注意到这些细节方面。

Java是一种大小写敏感的语言,在命名时一定要区分大小写。

    1、Package(包)的命名:采用完整的英文描述符,应该都是由小写字母组成。

    2、Interface(接口)、Class(类)的命名: 采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。通常由多个单词合成一个类名,要求每个单词的首字母也要大写。

    3、方法的命名: 方法名的第一个单词应该是动词,大小写可混用,但首字母应小写。在每个方法名内,大写字母将词分隔并限制使用下划线。参数的名字必须和变量的命名规范一致。使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:

               setCounter(int size){
                      this.size = size;
               }

    4、数组的命名: 数组应该总是用下面的方式来命名:byte[] buffer;而不是:byte buffer[](习惯性问题而已)。

    5、使用完整描述符来准确地描述变量、字段或类。

             例如,使用的名称可以是 FirstName、GrandTotal 或 Corporate Customer。虽然像 x1、y1 或 fn 这样的名称较短容易输入,但是它们并不提供任何信息指出它们所代表的内容。这样对代码的理解、维护和增强会造成一定困难。

    6、使用适用于领域内的术语。

        如果您的用户将他们的客户称为顾客,则对这个类使用术语Customer来代替Client。

    7、避免长型名称(小于15 个字符比较合适),巧妙节俭地使用缩写,将标准首字母缩写词的第一个字母大写。

        虽然类名 AllImplemented IterfacesAndSubclass 可能是个比较好的类名(当然,在此示例中有些夸张),但是这个名称显然太长,应该把它重命名为较短的名称才好。

        名称会经常包含标准缩写,如 SQL 表示“Standard Query Language”。诸如表示属性的 sqlDatabase 或表示类的 sQLDatabase 等名称比sQLDatabase 和SQLDatabase 更便于阅读。  

    8、使用大小写混合增强名称的可读性。

        通常应该使用小写字母,但是将类名和接口名称的第一个字母写成大写,将所有非起始单词的第一个字母也写成大写。

    9、属性(变量)的第一个字母要小写

            变量的命名: 变量的名字可大小写混用,但首字符应小写。词由大写字母分隔,限制用下划线和美元符号($),因为这个字符对内部类有特殊的含义,常量要全大写,并且指出完整含义,例如:final MAXUPLOADFILESIZE=1024。

    10、避免名称过于相似或仅在大小写方面有区别。

        不应该同时使用变量名 myObject 和 myObjects,也不应该同时使用 myOraDatabase 和 anORADatabase。
您需要登录后才可以回帖 登录 | 注册

本版积分规则

Archiver|手机版|小黑屋|软晨网(RuanChen.com)

GMT+8, 2024-11-22 18:36

Powered by Discuz! X3.5

Copyright © 2001-2023 Tencent Cloud.

快速回复 返回顶部 返回列表