鍍金池/ 教程/ Java/ 7.2 摘要片段
4.8.7 Modifiers
5.2.4 常量名
3.3.2 不要換行
4.8.6 注釋
7.3.3 可選的Javadoc
3.3.3 順序和間距
4.8.3 數(shù)組
4.6.2 水平空白
5.2.1 包名
2.1 文件名
5.1 對所有標(biāo)識符都通用的規(guī)則
3.4.1 只有一個(gè)頂級類聲明
7.1 格式
7.1.1 一般形式
5.2.3 方法名
6.2 捕獲的異常:不能忽視
源文件結(jié)構(gòu)
4.5.1 從哪里斷開
編程實(shí)踐
7.3.2 例外:重載
前言
4.8.1 枚舉類
格式
2.3 特殊字符
5.2.8 類型變量名
4.5.2 自動換行時(shí)縮進(jìn)至少+4個(gè)空格
源文件基礎(chǔ)
5.2 標(biāo)識符類型的規(guī)則
3.3.1 import不要使用通配符
7.3 哪里需要使用Javadoc
3.4.2 類成員順序
4.6.3 水平對齊:不做要求
4.6 空白
4.1.3 空塊:可以用簡潔版本
4.3 一行一個(gè)語句
5.2.2 類名
4.5 自動換行
1.2 指南說明
5.2.6 參數(shù)名
5.3 駝峰式命名法(CamelCase)
3.4 類聲明
4.8.2 變量聲明
5.2.7 局部變量名
4.1.2 非空塊:K & R 風(fēng)格
3.3 import語句
4.7 用小括號來限定組:推薦
6.1 @Override:能用則用
7.1.2 段落
4.8 具體結(jié)構(gòu)
4.2 塊縮進(jìn):2個(gè)空格
4.1 大括號
2.2 文件編碼:UTF-8
4.8.5 注解(Annotations)
6.4 Finalizers: 禁用
7.1.3 Javadoc標(biāo)記
命名約定
2.3.3 非ASCII字符
Javadoc
3.1 許可證或版權(quán)信息
7.2 摘要片段
5.2.5 非常量字段名
4.4 列限制:80或100
1.1 術(shù)語說明
2.3.2 特殊轉(zhuǎn)義序列
4.8.4 switch語句
6.3 靜態(tài)成員:使用類進(jìn)行調(diào)用
7.3.1 例外:不言自明的方法
4.6.1 垂直空白
4.1.1 使用大括號(即使是可選的)
Google Java編程風(fēng)格規(guī)范
3.2 package語句
2.3.1 空白字符

7.2 摘要片段

7.2 摘要片段

每個(gè)類或成員的Javadoc以一個(gè)簡短的摘要片段開始。這個(gè)片段是非常重要的,在某些情況下,它是唯一出現(xiàn)的文本,比如在類和方法索引中。

這只是一個(gè)小片段,可以是一個(gè)名詞短語或動詞短語,但不是一個(gè)完整的句子。它不會以A {@code Foo} is a...This method returns...開頭, 它也不會是一個(gè)完整的祈使句,如Save the record...。然而,由于開頭大寫及被加了標(biāo)點(diǎn),它看起來就像是個(gè)完整的句子。

Tip:一個(gè)常見的錯誤是把簡單的Javadoc寫成/** @return the customer ID */,這是不正確的。它應(yīng)該寫成/** Returns the customer ID. */。