コードレビューの時に使う略語集
最近会社で大量のコードレビューをしているのですが、似たような内容を一行一行タイプしている事がアホらしくなってきています。もっと良いやり方はないかなーと考えていたら大学生の時に最初に受けたプログラミングの授業を思い出しました。その授業では、教授がコードを採点するときに、減点箇所の指摘内容を略語を使って表現していました。当時は、あまりなんとも思ってなかったのですが、略語にすればキーを打つ回数が減るので書く側は楽ですし、伝えたい内容の結論が最初に書かれているので読む方も一度略を覚えてしまえば、楽になるのではないだろうか。
仮説なのであまり説得力がありませんが、自分は近日チームと相談して実践してみようと思います。以下に使う予定の略語一覧を開示しておくので興味のある方は参考にしてみてください。
| 略語 | 意味（英語） | 意味（日本語） |
|---|---|---|
| ANC | Avoid Nested Conditions | ネストした条件は省く |
| BCN | Bad Class Name | クラス名がいけてない |
| BMN | Bad Method Name | メソッド名がいけてない |
| BVN | Bad Variable Name | 変数名がいけてない |
| IND | Indentation Inconsistent | インデントが一貫じゃない |
| MM | Mismatch | 書いてあることとやっていることが違う |
| NETC | Not Enough Test Cases | テストケースが足りない |
| NG | Not General | 一般的ではない |
| TC | Too Complicated | 複雑すぎ |
| TE | Throws Exception | エラーが発生する |
| TMRC | Too Much Repeated Code | 類似コード多すぎ（コピペ） |
| UIV | Unnecessary Instance Variable | 不要なインスタンス変数 |
| VS | Violates Specifications | 規約・仕様違反 |
