每个单词的第一个字母都大写,来得到大驼峰式命名 。除了第一个单词,每个单词的第一个字母都大写,来得到小驼峰式命名 。
Prose formCorrectIncorrect------------------------------------------------------------------"XML HTTP request"XmlHttpRequestXMLHTTPRequest"new customer ID"newCustomerIdnewCustomerID"inner stopwatch"innerStopwatchinnerStopWatch"supports IPv6 on iOS?"supportsIpv6OnIossupportsIPv6OnIOS"YouTube importer"YouTubeImporterYoutubeImporter*
加星号处表示可以,但不推荐 。Note:在英语中,某些带有连字符的单词形式不唯一 。例如:"nonempty"和"non-empty"都是正确的,因此方法名checkNonempty和checkNonEmpty也都是正确的 。编程实践6.1 @Override:能用则用只要是合法的,就把@Override注解给用上 。
6.2 捕获的异常:不能忽视除了下面的例子,对捕获的异常不做响应是极少正确的 。(典型的响应方式是打印日志,或者如果它被认为是不可能的,则把它当作一个AssertionError重新抛出 。)
如果它确实是不需要在catch块中做任何响应,需要做注释加以说明(如下面的例子) 。
try {int i = Integer.parseInt(response);return handleNumericResponse(i);} catch (NumberFormatException ok) {// it's not numeric; that's fine, just continue}return handleTextResponse(response);
例外:在测试中,如果一个捕获的异常被命名为expected,则它可以被不加注释地忽略 。下面是一种非常常见的情形,用以确保所测试的方法会抛出一个期望中的异常, 因此在这里就没有必要加注释 。try {emptyStack.pop();fail();} catch (NoSuchElementException expected) {}
6.3 静态成员:使用类进行调用使用类名调用静态的类成员,而不是具体某个对象或表达式 。Foo aFoo = ...;Foo.aStaticMethod(); // goodaFoo.aStaticMethod(); // badsomethingThatYieldsAFoo().aStaticMethod(); // very bad
6.4 Finalizers: 禁用极少会去重载Object.finalize 。Tip:Javadoc7.1 格式7.1.1 一般形式Javadoc块的基本格式如下所示:
不要使用finalize 。如果你非要使用它,请先仔细阅读和理解Effective Java 第7条款:“Avoid Finalizers”,然后不要使用它 。
/** * Multiple lines of Javadoc text are written here, * wrapped normally... */public int method(String p1) { ... }
或者是以下单行形式:/** An especially short bit of Javadoc. */
基本格式总是OK的 。当整个Javadoc块能容纳于一行时(且没有Javadoc标记@XXX),可以使用单行形式 。7.1.2 段落空行(即,只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话) 。除了第一个段落,每个段落第一个单词前都有标签<p>,并且它和第一个单词间没有空格 。
7.1.3 Javadoc标记
标准的Javadoc标记按以下顺序出现:@param, @return, @throws, @deprecated, 前面这4种标记如果出现,描述都不能为空 。当描述无法在一行中容纳,连续行需要至少再缩进4个空格 。
7.2 摘要片段每个类或成员的Javadoc以一个简短的摘要片段开始 。这个片段是非常重要的,在某些情况下,它是唯一出现的文本,比如在类和方法索引中 。
这只是一个小片段,可以是一个名词短语或动词短语,但不是一个完整的句子 。它不会以A {@code Foo} is a...或This method returns...开头, 它也不会是一个完整的祈使句,如Save the record... 。然而,由于开头大写及被加了标点,它看起来就像是个完整的句子 。
Tip:7.3 哪里需要使用Javadoc至少在每个public类及它的每个public和protected成员处使用Javadoc,以下是一些例外:
一个常见的错误是把简单的Javadoc写成 /** @return the customer ID */,这是不正确的 。它应该写成/** Returns the customer ID. */ 。
7.3.1 例外:不言自明的方法对于简单明显的方法如getFoo,Javadoc是可选的(即,是可以不写的) 。这种情况下除了写“Returns the foo”,确实也没有什么值得写了 。
推荐阅读
- JavaScript 里的奇葩知识
- 对于 JavaScript 中循环之间的技术差异概述
- 推荐5个爆款Java开源博客,是我目前用过最好用的博客系统
- 为什么Java类不支持多继承而接口可以?
- 如何利用Java代码操作索引库?
- Java8——异步编程
- Java如何判断一个字符串中某个字符出现的次数?
- 开源JavaScript实用日期处理库——date-fns
- java 伪共享 False Sharing
- Java15的新特性