コードレビューまとめ

コードレビューで得られたよりキレイなソースコードを書くためのルールやより高速なプログラムにするなど改善のためのTIPSをまとめておきます．今後大きなプログラムを書くことになることに備えて丁寧なコーディングを行う習慣を身に付けましょう．

全体に言えること

一ヶ月後の自分が見てもわかるコードを書こう（見やすいコードを書くのはなにより自分のため！）
適切なコメントを残す
関数名，変数名には意味をもたせる
- a など適当な名前は付けない
複数単語を連結する場合
- キャメルケース: camelCaseのように単語の先頭を大文字にして連結する
- スネークケース: snake_caseのように_で連結する言語や変数名，クラス名など用いる箇所によって推奨される書き方が異なる
スコープを意識する
プログラムが巨大になりそうならモジュール分割する
- 関連する処理はクラスにまとめましょう
無闇にグローバル変数を宣言しない

python

Check list
- PEP8（コーディング規約）を遵守した
- docstringに基づきコメントを記述した
- 可読性の高い変数名をつけた
更に余裕があれば...
- 英語でコメントを記述した
- 関数やクラスなど再利用を意識して実装した
PEP8のチェックはエディタのプラグインを利用すると自動で指摘，修正してくれるので便利

例．Atomの場合（参考: atomでpythonのlinterを利用する）

演習で困ったら

まず自分でネットで調べる
10分調べてもわかりそうになかったら先輩に聞く
- 直接聞いても良いけど、b4lecture-2021にスレッド立ててくれると、みんなが見れて嬉しい。(君が分からないことに、みんなも困っている!!)
エラーメッセージをよく読みましょう
- 例えばsegmentation faultなら配列の外など不正なメモリアクセスをしています
- エラーメッセージで検索すると同じエラーが出た人の解決策が見つかることがあります
デバッグをしてみよう
- エラーの原因を特定するために変数をprintして中身を見てみましょう（通称：printデバッグ）
- デバッガを利用しよう
  - pythonならpdbが標準モジュールで用意されている
  - IDEを利用している場合は詳しく処理の中身を見たいところにブレークポイントを置く

質問の仕方

質問は積極的にしましょう
わからないところや聞きたいことを明確にしておくとスムーズです（参考：質問は恥ではないし役に立つ）