コーディング規約集

[tarepan]

voicevox_engine で実際に課題として挙がり、採用の方向性で検討されているコーディング規約の一覧

規約

1. プライベート関数（voicevox_engine レポジトリに閉じたローカル関数）は _ で始まる名称が好ましい
2. 演算子オーバーロードの採用は大きなメリットが見込める場合に限る
3. YAMLファイルの拡張子は .yaml を原則とする。GitHub Actions/Workflow は例外として .yml に統一
4. docstring はフォーマルの場合 NumPy 型とする。正確性を担保しつつ可読性を向上できるならワンライナーOK
5. 名前付き引数の採用は以下に従う：
   a. 同じ型の引数が２つあり、可換でないなら、名前付き引数にすべき
   b. intやbooleanなどのプリミティブな型はダブりやすいので、名前付き引数にしとくと良い
   c. できる限りブランド型を使おう
6. API で expose される型は model モジュールに配置
7. コードコメントは以下に従う：
   a. コメントはコードを読みやすくするために書かれる
   b. 短くわかりやすいコメントの方が良い
   c. コードから読み取れない開発者の大事な意図は書いた方が良い
   d. あったほうが読む時間の短縮になる説明は書いても良い
   e. リーダブルコードの考え方はよく引用します

各規約が制定された背景 issues

1. Remove: to_phoneme_data_list() の廃止 #796
2. Remove: OjtPhoneme 特殊Equal廃止 #787
3. YAMLファイルの拡張子の表記揺れを統一したい #753
4. docstringの整備 #59
5. 整理: TTSEngine メソッドのリネーム #956
6. APIのstyle_idの型をStyleId型に #966
7. 整理: replace_mora_pitch #974

TODOs

• docs/貢献ガイドライン.md

[tarepan]

現時点で議題はなく、常時 open の #1100 にリンクが貼られたため close。
規則追加は適宜行う。