由于我對(duì)checkstyle也不是很熟悉缓淹，在這里就根據(jù)checkstyle檢查我所做的團(tuán)隊(duì)項(xiàng)目的結(jié)果來羅列一下常見的錯(cuò)誤每币。以下按錯(cuò)誤的從多到少排列力麸。
| checkstyle violation type | 解釋 | 解決 | 備注 |
|---|---|---|---|
| Missing a Javadoc comment | 缺少JavaDoc注釋 | 增加javadoc注釋 | javadoc-百度百科 |
| 'X' is not followed by whitespace | “X”后面缺少空格 | 添加空格 | |
| Line has trailing spaces. | 多余的空行 | 去掉空行 | |
| Parameter 'X' should be final | “X”應(yīng)該為final類型 | 在前面加個(gè)final | |
| name 'X' must match pattern 'X' | 變量“X”不符合命名規(guī)則“X” | 把這個(gè)命名改成符合規(guī)則的命名 | |
| 'X' is not preceded with whitespace | “X”前面沒有空格 | 添加空格 | |
| 'X' hides a field. | 全局和局部變量名字重復(fù) | 重命名 | |
| Line is longer than X characters | 行長度超過X | 分成多行寫 | 文字分散對(duì)齊Ctrl+shift+f |
| Expected X tag for'X' | 在注釋中希望有X的說明 | 在方法前得注釋中添加注釋 | |
| Redundant 'X' modifier | 冗余的“X” | 刪除X | |
| File contains a tab characters | 文件中含有”tab” 字符 | 把tab換成四個(gè)空格 | 可以使用Editplus中的format功能 |
| 'X' is a magic number | X是一個(gè)魔術(shù)數(shù)字(非0拐辽、1、2的數(shù)字) | 對(duì)于直接用代碼中的數(shù)字佛吓，進(jìn)行常量的定義 | 一般沒什么關(guān)系 |
| Unused import -X | 導(dǎo)進(jìn)來的X沒有被使用 | 去掉導(dǎo)入的多余的類 | |
| Expected an @return tag | 希望有一個(gè)return的注釋 | 添加該注釋 | |
| First sentence should end with a period | 你的注釋的第一行文字結(jié)束應(yīng)該加上一個(gè)"." | 加上“.” | |
| 'X' Is preceeded with whitespace | “X”前面不能有空格 | 去掉空格 | |
| Variable X' must be private and have accessor methods | 變量要改成private然后提供訪問的方法 | 給這些變量的修飾符改成private宵晚，然后提供set，get方法维雇，并加上對(duì)應(yīng)的方法javadoc注釋淤刃、參數(shù)注釋。 | |
| File does not end with a newline | 刪掉報(bào)錯(cuò)的類谆沃，新建一個(gè)同名的類钝凶，把代碼全部復(fù)制過去 |
