鍍金池/ 教程/ Java/ 4.8.6 注釋
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 對(duì)所有標(biāo)識(shí)符都通用的規(guī)則
3.4.1 只有一個(gè)頂級(jí)類(lèi)聲明
7.1 格式
7.1.1 一般形式
5.2.3 方法名
6.2 捕獲的異常:不能忽視
源文件結(jié)構(gòu)
4.5.1 從哪里斷開(kāi)
編程實(shí)踐
7.3.2 例外:重載
前言
4.8.1 枚舉類(lèi)
格式
2.3 特殊字符
5.2.8 類(lèi)型變量名
4.5.2 自動(dòng)換行時(shí)縮進(jìn)至少+4個(gè)空格
源文件基礎(chǔ)
5.2 標(biāo)識(shí)符類(lèi)型的規(guī)則
3.3.1 import不要使用通配符
7.3 哪里需要使用Javadoc
3.4.2 類(lèi)成員順序
4.6.3 水平對(duì)齊:不做要求
4.6 空白
4.1.3 空塊:可以用簡(jiǎn)潔版本
4.3 一行一個(gè)語(yǔ)句
5.2.2 類(lèi)名
4.5 自動(dòng)換行
1.2 指南說(shuō)明
5.2.6 參數(shù)名
5.3 駝峰式命名法(CamelCase)
3.4 類(lèi)聲明
4.8.2 變量聲明
5.2.7 局部變量名
4.1.2 非空塊:K & R 風(fēng)格
3.3 import語(yǔ)句
4.7 用小括號(hào)來(lái)限定組:推薦
6.1 @Override:能用則用
7.1.2 段落
4.8 具體結(jié)構(gòu)
4.2 塊縮進(jìn):2個(gè)空格
4.1 大括號(hào)
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ù)語(yǔ)說(shuō)明
2.3.2 特殊轉(zhuǎn)義序列
4.8.4 switch語(yǔ)句
6.3 靜態(tài)成員:使用類(lèi)進(jìn)行調(diào)用
7.3.1 例外:不言自明的方法
4.6.1 垂直空白
4.1.1 使用大括號(hào)(即使是可選的)
Google Java編程風(fēng)格規(guī)范
3.2 package語(yǔ)句
2.3.1 空白字符

4.8.6 注釋

4.8.6 注釋

4.8.6.1 塊注釋風(fēng)格

塊注釋與其周?chē)拇a在同一縮進(jìn)級(jí)別。它們可以是/* ... */風(fēng)格,也可以是// ...風(fēng)格。對(duì)于多行的/* ... */注釋?zhuān)罄m(xù)行必須從*開(kāi)始, 并且與前一行的*對(duì)齊。以下示例注釋都是OK的。

/*
 * This is          // And so           /* Or you can
 * okay.            // is this.          * even do this. */
 */

注釋不要封閉在由星號(hào)或其它字符繪制的框架里。

Tip:在寫(xiě)多行注釋時(shí),如果你希望在必要時(shí)能重新?lián)Q行(即注釋像段落風(fēng)格一樣),那么使用/* ... */。