汎用コードチェックリスト(兼汎用コーディング規約) - ntuf/Tips GitHub Wiki
・チェックリストになっていると良い ・そのまま印刷してもきれい ・都度都度のプロジェクトでコピーして使える(適用するかは都度検討) ・理由を明記する 納得できる理由 ・検出方法も明記する
チェック | チェック内容 | 詳細 | 理由 | 検出方法 |
---|---|---|---|---|
実装せず他を利用できないか | パッケージ、(オープンソース)ライブラリ、共通関数の利用 | コスト低減,信頼性の向上 | ||
コードの補足情報 | コードの実行方法、依存関係をREADME.mdなどに書く | |||
コメントは適切に記述されているか | 他者がみて可読性が高いか | |||
不要なコードが残っていないか | コードのコメントアウト等 | |||