当方のコーディングルールは下記のようになっております。
ソースレビュー時はこちらをご確認頂ければ幸いです。
別途指定があれば、作業前にご連絡頂けると助かります。
基本ルール
- PSR-2（PHP CS Fixer使用）
- JavaDocフォーマット
※swagger等、他のものを指定の際はご連絡ください。 - 保守性・分離性
※依存を少なく、切り離し容易な構造を、基本としています。 - 読みやすい記述法（引継ぐ前提）
- コメント多め（引継ぐ前提）
切り離しと読みやすさを重視するため、若干記述が多めになります。
簡略表記や軽量化を重視する場合は、作業前ご連絡ください。
命名ルール
- 英語の記述は大文字・小文字を混ぜる
- 英語記述はフルスペル
- 名前は長すぎない(極力短く)
- 誤解を招くような名前を避ける
単語の組み合わせ または 翻訳サイト頼みの英文です。
例えばボールの個数の場合、CountBallとなります。
事前に命名規則をご指定くだされば、合わせます。
コメントルール
- 日本語を使用する
- 記号を使用(タイトル行や箇条書き)
- コメントは簡潔に
- JavaDocフォーマット
※swagger等指定時は要連絡 - ソースのヘッダ・クラス・変数・メソッド・コンストラクタは必須
コメントは基本日本語です。
英語等、言語に指定ある場合、作業前ご連絡ください。
ソースレビュー
レビューは頂ける時間量に比例した対応になります。
基本は自己確認・自己チェックのみの『自己レビュー』のみの対応です。
チェックシート提出や会議レビュー等、必要な場合はご連絡ください。
- 誤字・脱字や用語の不統一など
- ルール違反がないか、文章表現に問題がないか
- 資料の誤りやプログラム原作者の資料や解釈ミス
- 業務要件の実現性
- 問題を見つけたら、他に類似した箇所がないか
コメント