Java中的命名规则.doc

1. Java中的命名规则 2. 3. 4. 在面向对象编程中，对于类，对象，方法，变量等方面的命名是非常有技巧的。比如，大小写的区分，使用不同字母开头等等。但究其本，追其源，在为一个资源其名称的时候，应该本着描述性以及唯一性这两大特征来命名，才能保证资源之间不冲突，并且每一个都便于记忆。 5. 6. 包的命名 7.8. 9. Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性，每一名Java程序员都可以编写属于自己的Java包，为了保障每个Java包命名的唯一性，在最新的Java编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 10. 例如：net.frontfree.javagroup 11.12. 13. 类的命名 14. 15. 类的名字必须由大写字母开头而单词中的其他字母均为小写；如果类名称由多个单词组成，则每个单词的首字母均应为大写例如TestPage；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。 16. 例如：Circle 17. 18. 方法的命名 19. 20. 方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。 21. 例如：sendMessge 22. 23. 常量的命名 24. 25. 常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。 26. 例如：MAX_VALUE 27. 28. 参数的命名 29. 30. 参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。 31. 32. Javadoc注释 33. 34. Java除了可以采用我们常见的注释方式之外，Java语言规范还定义了一种特殊的注释，也就是我们所说的Javadoc注释，它是用来记录我们代码中的API的。Javadoc注释是一种多行注释，以结束，注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。 35. 例如： 36. 37. 38. 39. 在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在主程序中可以为每个类、接口、方法、字段添加Javadoc注释，每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的auther和version，这些段落将在生成文档中以特定方式显示。 40. 虽然为一个设计低劣的程序添加注释不会使其变成好的程序，但是如果按照编程规范编写程序并且为程序添加良好的注释却可以帮助你编写出设计完美，运行效率高且易于理解的程序，尤其是在多人合作完成同一项目时编程规范就变得更加重要。俗话说“磨刀不误砍柴工”，花费一点时间去适应一下Java编程规范是有好处的。 Java代码 1. .NET中的命名规则 2. 3. 4. 5. 名称空间的命名 6. 7. 命名名称空间的一般规则如下： 8. CompanyName.TechnologyName 9. 这样，我们看到的名称空间应该是这样的： 10. Microsoft.Office 11. PowerSoft.PowerBuilder 12. 13. 注意：这只是一个原则。第三方公司可以选择其它的名字。 14. 避免用公司名称或其它著名品牌的名称作为名称空间的前缀，这样会造成两个公布的名称空间有同一个名称的可能性。 15. 例如：将微软提供的Office自动类命名为Microsoft.Office 16. 17. 使用Pascal大写方式，用逗号分隔逻辑成分。 18. 例如：Microsoft.Office.PowerPoint 19. 20. 如果你的品牌使用的是非传统大写方式，那么一定要遵循你的品牌所确定使用的大写方式，即使这种方式背离了通常的名称空间大写规则。 21. 例如：NeXT.WebObjects 22. ee.cummings 23. 24. 25. 类和类成分的命名 26. 27. 类的命名原则是用名词或名词短语命名类，使用Pascal大写。减少类名中缩写的使用量。不要使用任何类前缀（比如C），不要使用带下划线的字符。 28. 例如：publicclassFileStream 29. publicclassButton 30. publicclassString 31. 32. 变量的命名 33. 34. 名称中各单词首字母均为大写。 35. 例如：FindLastRecord 36. RedrawMyForm 37. 在内部范围中避免使用与外部范围中的名称相同的名称。若访问错误变量，则会产生错误结果。若变量与同一名称的关键字冲突，则必须在关键字前加适当的类型库以作标识。 38. 例如：若有一个名为date的变量，只能通过调用System.Date来使用内部Date函数。 39. 40. 函数和方法的命名 41. 42. 函数和方法的命名应该以动词开始，使用Pascal大写。不要使用带下划线的字符。 43. 例如：InitNameArray 44. CloseDialog 45. 46. 接口命名原则 47. 48. 使用名词或名词短语，或者描述行为的形容词来命名接口,使用Pascal大写。减少接口名中缩写的使用量，在接口名前加前缀I，以表示这个类型是一个接口。 49. 例如：IComponent（描述性名词） 50. ICustomAttributeProvider（名词短语） 51. IPersistable（形容词） 52. 53. 参数的命名 54. 55. 使用描述性参数名。参数名应该具有足够的描述性，这样在大多数情况下参数名和它的种类可以用来确定它的意思。根据参数的意思来命名参数，而不是根据参数的种类来命名。我们希望开发工具可以用很方便的方式提供关于参数种类的信息，这样参数名可以得到更好的使用，可以对语义而不是对种类进行描述。但是偶尔使用根据类型命名的参数名也是完全可以的。不要使用保留参数。如果在下一个版本中需要更多的数据，可以增加进来。 56. 例如：TypeGetType(stringtypeName) 57. stringFormat(stringformat,objectargs) 58. 59. 属性的命名 60. 61. 用名词或名词短语命名属性，属性与类型要一样。用与一个类型的名称相同的名字来命名属性时，就使这个属性的类型成为那个类型。虽然听起来有些奇怪，但这是正确的。 62. 例如：publicenumColor. 63. publicclassControl 64. publicColorColorget.set. 65. 66. 67. 事件的命名 68. 69. 用EventHandloer后缀命名事件处理程序，使用名为sender和e的两个参数，Sender参数代表提出事件的对象。Sender参数永远是一个类型对象，即使它可能使用了更为特定的类型，与事件相关的状态被封装在一个名为e的事件类范例中。要使用这个类型的正确的、特定的事件类。 70. 例如：publicdelegatevoidMouseEventHandler(objectsender,MouseEvente); 71. 命名事件名时，需要有之前和之后的时态概念，因此要使用现在时态和过去时态（不要使用BeforeXxxAfterXxx的方式）。例如，可以被取消的结束事件就有Closing事件和Closed事件。 72. 73. 长项和常用项的命名 74. 75. 可使用缩写使名称长度适中，通常，多于32个字符的变量名在低分辨率的监视器上难以阅读。同时，请确保缩写在整个应用程序中保持一致。 76. 例如：可以使用“HTML”代替“HyperTextMarkupLanguage”。 77. 78. 代码书写格式规范 79. 80. 文件之中不得存在无规则的空行，比如说连续十个空行。一般来讲函数与函数之间的空行为2-3行。 81. 在函数体内部，在逻辑上独立的两个函数块可适当空行，一般为1-2行。 82. 每行长度尽量避免超过屏幕宽度，应不超过80个字符。 83. 尽量用公共过程或子程序去代替重复的功能代码段。 84. 使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。如将x=a*b/c*d写成x=(a*b/c)*d可避免阅读者误解为x=(a*b)/(c*d)。 85. 避免采用过于复杂的条件测试。 86. 避免过多的循环嵌套和条件嵌套。 87. 一个函数不要超过200行。一个文件应避免超过2000行。 88. 避免使用goto语句。 89. 避免采用多赋值语句，如x=y=z;。 90. 代码注释规范 91. 92. .cs文件的注释 93. 所有.cs文件开头都要加上注释，写明文件创建时间、作者、用途概述等 94. 例如： 95. 96. /* 97. 98. /新增日期:2004.7.19 99. 100. /作者:XXX 101. 102. /內容说明:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 103. 104. /* 105. 106. 函数过程注释 107. 所有的函数体开头都要加上注释，所以注释使用.NET注释规范。 108. 例如： 109. 110. / 111. 112. /构造函数 113. 114. / 115. 116. /示例参数1 117. 118. /示例参数2 119. 120. publicUpgradeThread(stringis_xxx1,stringis_xxx2) 121. 122. 123. 124. / 125. 126. 127. 常量变量注释 128. 所有的常量变量，无论是全局还是局部使用的，凡是对代码整体起到关键性做用的都需要加上注释。 129. 例如： 130. 131. / 132. 133. /当前线程指向的备份文件本地保存路径 134. 135. / 136. 137. publicstringStorePath=; 138. 139. 代码修改注释 140. 当开发者维护以前的程序代码时，需要在修改处的开始及结尾，加上自己的注释信息。 141. 例如： 142. 143. /BEGIN2004-7-19Jayson修正了XXX问题 144. 略 145. /END2004-7-19Jayson 146. 147. Java代码 1. PHP中的命名规则 2. 3. 类的命名 4. 5. 在为类（class）命名前首先要知道它是什么。如果通过类名的提供的线索，还是想不起这个类是什么的话，那么就说明设计存在问题。 6. 超过三个词组成的混合名是容易造成系统各个实体间的混淆，尝试使用（CRCSe-ssioncard)看看该命名所对应的实体是否有着那么多的功用。 7. 对于派生类的命名应该避免带其父类名的诱惑，一个类的名字只与它自身有关，和它的父类叫什么无关。 8. 使用大写字母作为词的分隔，其他的字母均使用小写，名字的首字母使用大写。不要使用下划线(_)。 9. 例如：classNameOneTwo 10. className 11. 12. 类库的命名 13. 14. 目前命名空间正在越来越广泛的被采用，以避免不同厂商和团体类库间的类名冲突。当尚未采用命名空间的时候，为了避免类名冲突，一般的做法是在类名前加上独特的前缀，两个字符就可以了，当然多用一些会更好。 15. 例如：JohnJohnson的数据结构类库可以用Jj做为前缀，如下： 16. classJjLinkList 17. 18. 19. 20. 方法的命名 21. 22. 采用与类命名一致的规则，同样是使用英文单词诠释出方法的作用。 23. 例如：classNameOneTwo 24. 25. functionDoIt(); 26. functionHandleError(); 27. 28. 29. 类属性的命名 30. 31. 属性命名应该以字符m为前缀。前缀m后采用于类命名一致的规则。m总是在名字的开头起修饰作用，就像以r开头表示引用一样。 32. 前缀m防止类属性和方法名发生任何冲突。你的方法名和属性名经常会很类似，特别是存取元素。 33. 例如：classNameOneTwo 34. 35. functionVarAbc(); 36. functionErrorNumber(); 37. varmVarAbc; 38. varmErrorNumber; 39. varmrName; 40. 41. 42. 方法中参数的命名 43. 44. 第一个字符使用小写字母。在首字符后的所有字都按照类命名规则首字符大写。 45. 这样做可以随时知道哪个变量对应哪个变量。另外，这样做可以使用与类名相似的名称而不至于产生重名冲突。 46. 例如：classNameOneTwo 47. 48. functionStartYourEngines( 49. &$rSomeEngine, 50. &$rAnotherEngine); 51. 52. 53. 变量的命名 54. 55. 所有字母都使用小写。使用_作为每个词的分界 56. 通过这一途径，代码中变量的作用域是清晰的。所有的变量在代码中都看起来不同，容易辨认。 57. 例如：functionHandleError($errorNumber) 58. 59. $error=OsErr(); 60. $time_of_error=OsErr-getTimeOfError; 61. $error_processor=OsErr-getErrorProcessor; 62. 63. 64. 全局变量的命名 65. 66. 全局变量应该带前缀g。 67. 知道一个变量的作用域是非常重要的。 68. 例如：global$gLog; 69. global&$grLog; 70. 71. 函数的命名 72. 73. 函数名字采用CGNU的惯例，所有的字母使用小写字母，使用_分割单词。 74. 这样可以更易于区分相关联的类名。 75. 例如：functionsome_bloody_function() 76. 77. 78. 79. NoahWeb中的命名规则NoahWeb汲取了各种编程语言的精华，经过反复的总结，最终形成了一套独特且高效的命名规则。在命名的过程中，使用“资源名称功能描述”的方式，保证了资源之间的唯一性，并且大大提高了资源的描述性和阅读性。页面或动作传值命名规则应用规则示范传递id使用pointidabc.aspx?pointid=123传递name使用pointnameabc.aspx?pointname=xxx搜索关键词keywordabc.aspx?keyword=xxx当前页索引pageabc.aspx?page=1字符资源命名规则应用规则示范针对表的列表命名list_表名_功能名list_user_view手写数据库操作集sql_表名或功能名sql_user_search表单命名规则应用规则示范表单id命名表名+功能userLogin输入区控件id命名form+对应数据库的列名formId；formname数据库操作命名规则应用规则示范查询表名_S_条件+功能说明user_S_ByIduser_S_ByNameuser_S_Pagelistuser_S_ByNamePagelistuser_S_ByNameSearchuser_S_ByIdTopTenuser_S_ByDateTopTenuser_S_ByDateTopFiveuser_S_ByDateTopSet删除表名_D_条件+功能说明user_D_ById插入表名_I_+功能说明user_I_NewData更新表名_U_条件+功能说明user_U_ByIdChangePassword动作命名规则应用规则示范动作命名表名+所属功能+操作方式（add:添加输入区显示add_ex:添加执行list:列表显示内容search:搜索viewinfo:显示详细信息update_ex:更新执行del: 删除执行)user_manager_adduser_manager_add_exuser_manager_listuser_manager_searchuser_manager_viewInfouser_manager_update_exuser_manager_del文件上传命名规则应用规则示范表单文件上传区命名规则myfile+编号myfile1myfile2myfile3cookie命名规则应用规则示范变量名命名cookie+变量名cookieusernameJava代码 1. 网站文件命名规则 2. 3. 关于文件的命名，看似无足重轻，但实际上如果没有良好的命名规则进行必要的约束，一味的乱起名称，最终导致的结果就是整个网站或是文件夹无法管理。所以，命名规则在这里同样非常重要。需要特别注意的时候，网站文件或文件夹命名请尽量避免使用中文字符命名。 4. 5. 文件的命名 6. 7. 以最少的字母达到最容易理解的意义。 8. 索引文件统一使用index.html文件名(小写)index.html文件统一作为桥页，不制作具体内容，仅仅作为跳转页和meta标签页。主内容页为main.html。 9. 按菜单名的英语翻译取单一单词为名称。所有单英文单词文件名都必须为小写，所有组合英文单词文件名第二个起第一个字母大写；所有文件名字母间连线都为下划线。 10. 例如：关于我们aboutus 11. 信息反馈feedback 12. 产品product 13. 14. 图片的命名 15. 16. 以图片英语字母为名。以最少的字母达到最容易理解的意义。 17. 对于较小的图片，我们使用如下格式的命名： 18. sm.kahn.gif 19. 其中，sm代表“small”，kahn代表图片的内容。较大图像的命名规则也一样，不过是以bg开头的： 20. bg.kahn.gif 21. 用以区分不同图像的命名规则应当是全站通用的，这样可以尽量避免将不同的名称搅混。 22. 23. 网站目录的命名 24. 25. 目录建立的原则是以最少的层次提供最清晰简便的访问结构。 26. 服务器的ftp上传目录默认为html根目录文件根目录只允许存放index.html和main.html文件，以及其他必须的系统文件。 27. 每个语言版本存放于独立的目录。已有版本语言设置为：简体中文gb繁体中文big5英语en日语jp每个主要功能(主菜单)建立一个相应的独立目录。根目录下的images为存放公用图片目录，每个目录下私有图片存放于各自独立images目录. 28. 例如：menu1images 29. menu2images 30. 另外，所有的js文件存放在根目录下统一目录script所有的CSS文件存放在根目录下的style目录所有的CGI程序存放在根目录并列目录cgi_bin目录。 31. 对于一些信息更新量比较大的站点或是栏目，还可以采用一种更为特殊的方式来进行文件架的命名，这样能使得日后的维护更加方便，这样的方式就是使用“单一单词命名的目录”+“年年年年_月月_日日”的方式命名，最后的“日日”是根据更新量大小可选择的，如果每日更新量很大则可以加上“日日”。 32. 例如：news2005_08 33. news2005_09 34. news2005_10_12 35. 36. Java代码 1. Dreamweaver文件的命名规则 2. 3. 4. 在Dreamweaver中用户可以对一系列不同类型的对象进行命名，这些对象包括图片、层、表单、文件、数据库域等，这些对象将会被许多不同的工作引擎进行分析处理，这些工具包括各种浏览器、JavaScript脚本解析器、网络服务器、应用程序服务器、查询语言等等。 5. 如果某个对象的名称无法被某个解析器识别，就有可能会导致故障的发生，更加麻烦的是用户可能很难发现问题的原因，例如某个具体的特效无法正确显示，或者是在某个特殊阶段无法正确显示，有时故障可能只会在某种特殊情况或在使用某个浏览器时发生，而在其它情况下保持正常，用户将很难分析出故障是由于命名问题而导致的。 6. 由于需要命名的对象的种类很多，对这些对象进行解析的引擎工具也很多，因此用户在给这些对象命名时应该遵循一个常规的标准，以确保普遍兼容性。命名的基本原则就是：使用独一无二的、小写、不带空格的名称，名称应由字母和数字组成，并以字母开始，名称中可以包含_符号。 7. 8. 独一无二 9. 10. 请确保某对象的名称与其它对象不同，保证其独一无二的属性。 11. 例如：你可以将某对象命名为feedback_button_3 12. 13. 小写 14. 15. 有些服务器和脚本解析器对文件名的大小写也进行检查，而为了避免因大小写引起的不兼容问题，建议用户在命名时全部使用小写文件名。 16. 17. 不带空格 18. 19. 不同的解析器对空格等符号的解析结果不同，例如某些解析器会把空格视为某个十六进制的数值，因此建议用户使用不带空格的单词做为文件对象的名称。 20. 21. 词数混合 22. 23. 用户在命名中可以随意使用26个罗马字母以及10个阿拉伯数字，而不建议使用其它标点符号。 24. 25. 以字母开始 26. 27. 有些解析器不喜欢以数字开头的文件名。 28. 例如：在某些浏览器中的JavaScript脚本内部，如果使用alpha23这样的名称就不会出现问题，而如果使用23alpha这样的名称就可能会发生故障。 29. 30. 可包含_符号 31. 32. 为了使某个对象的文件名独一无二，用户可以通过使用_符号来更加详细地描述文件名。 33. 例如：某对象的文件名可以是jd_background_17。 34. 除了上述原则标准之外，我们还需要注意一些其它情况，如文件名与系统的冲突。某些文件名可能满足上述标准，但可能还会导致故障的发生，原因是因为它们与系统产生了冲突。 35. 例如：当在使用JavaScript脚本函数时，不建议用户将某个变量命名为for，因为for在本系统下是一个工作语言字串，使用其命名某个变量可能会导致解析器工作出错。许多程序都有一些保留名称，这些名称一般不建议用户使用。 36. 例如：用户使用某个SQL程序保留的名称来命名某个数据库域，SQL对其进行分析时就可能会报错。 37. 此外，用户在将不同来源的代码编到一起时，应该注意文件名的冲突情况。 38. 例如：用户把来自不同资源的两个JavaScript行为代码编至同一网页内，而这两个行为代码的变量名相同，这时就有可能出现问题。 39. 因此做为查询故障的一个技巧，在出现故障时，用户可以查询一下相同网页中是否存在相同文件名的变量名称。 Java代码 1. CSS类及id中的命名规则 2. 3. 4. Web开发人员可以通过创建CSS类及id名称并使用这些名称来对divs以及其他的格式页面元素进行标识。对开发人员来说，在命名重新定义XHTML标记（tags）的CSSselectors时，必须保证其与预定义的标记准确匹配，但就类以及id选择器名称而言，则仁者见仁，智者见智。然而随心所欲的为这些类以及id命名则并不是个好的习惯。 5. 6. 直观命名 7. 8. 当在设计Web页面以及需要对一个div进行标识的时候，最自然的想法就是使用可以描述元素所在页面位置的词汇来对其命名。 9. 例如：top-panel 10. horizontal-nav 11. left-side 12. center-column 13. right-col 14. 15. 这些是CSS以及XHTML类和id的有效命名方式。这些词汇简单并且能够使人顾名思义，因此满足了标识页面元素以及相应的CSS样式的需要。 16. 17. 但问题是这样的名称同页面内容的特定表达方式相关联。这些命名参考了某种特定页面布局中的页面元素位置，因此在这样的布局之外使用就会显得不合适甚至造成理解混乱。这些命名没有涉及文档内容的结构。因此，下面给出了对CSS类以及ID命名更好的方法。 18. 19. 结构化命名 20. 21. 22. 这些是CSS以及XHTML类和id的有效命名方式。这些词汇简单并且能够使人顾名思义，因此满足了标识页面元素以及相应的CSS样式的需要。这些是CSS以及XHTML类和id的有效命名方式。这些词汇简单并且能够使人顾名思义，因此满足了标识页面元素以及相应的CSS样式的需要。 23. 24. 有标记的相关信息都是用来描述文档的结构而不是外观。这样的特点使得我们可以通过简单的改变CSS的方式来对不同外观格式下的内容（content）以及标记（markup）进行重用。当你理解这种方式时，很容易就可以发现采用页面位置来为类以及id命名的方式在处理如音频（audio）等外观格式上显得非常不合适。因此，应当根据在文档中的使用目的而非出现位置来对类以及id进行结构化命名。 25. 26. 可以按照如下所示的结构化方式来对类以及id名称命名： 27. 例如：branding 28. main-nav 29. subnav 30. main-content 31. sidebar 32. 33. 这些名字同直观命名方式一样非常易懂，但他们描述了页面元素的作用而非位置。这使得代码更加符合使用纯粹的结构化标记（structuralmarkup）的初衷，即开发人员可以在不改变标记的情况下对各种各样媒体下的显示格式进行处理。 34. 35. 即使你不打算在其他的媒体上对Web页面进行格式修改，使用结构化命名方式还可以帮助你在日后的站点升级或重新设计中更为轻松。例如，结构化命名避免了当一个div同idright-column移动到页面左边后所带来的混乱。对divsidebar的采用这样的命名方式就显得更加适当，因为无论它出现在页面的哪一边，这个名字仍然对开发人员来说直观易懂。 36. 37. 38. 惯例 39. 40. 4