For more readable code

[Amusac]

目標

もっと読みやすく分かりやすくバグを起こしにくいコードを目指したい。

なぜやるのか

1. 教育目的のコードである
2. チームで作業するコードである
3. 次世代へ引き継がれるコードである

現状の問題意識

たとえば

• コードが読みづらい
• 真のオブジェクト指向になっていない
• PEP8準拠になっていない
• ドキュメンテーションが足りていない
• コード内コメントが少ない
• パラメータ入力形式が煩雑でバグを起こしやすく，エラーメッセージも分かりづらい

なにをやるのか

たとえば

• blackによるformatting
• メソッド名，変数名をできるだけ分かりやすいものに変更
• privateなメソッドを明示
• メソッドの命名規則をPEP8準拠に
• 不要なメソッドを削除
• オブジェクト指向プログラミングにおけるカプセル化を意識
• 適切なドキュメンテーション
• 適切なエラー出力
• 適切なコード内コメント