コードを書くときに意識すべき項目

1 min read読了の目安(約500字

about

自戒の意味を込めて自分でコードを書くときに意識することのリストを作ってみました。
なお、このリストは見た目に関してのみの項目です。

もはや鉄板と言えるこちらの本を参考にしつつ、実体験を通して今後もアップデートしていければと。
https://www.oreilly.co.jp/books/9784873115658/


命名

  • 明確な単語を選んでいる
  • 汎用的な名前を避ける
  • 具体的な名前を使う
  • 接尾辞や接頭辞を使って情報を付加する
  • 名前の長さを決める
  • 名前のフォーマットで情報を伝える
  • 誤解されない名前になっている

コードの見た目

  • 所作の似ているコードブロックはインデントを使ってシルエットも合わせる
  • コードの列を整列させる
  • 順番で並べているものの並べ方は統一する
  • 空白を使って段落に分ける

コメント

  • 意味のないコメントを書かない
  • 自分の考えや理由を記録する
  • 読み手の立場になって、必要と思われるところにコメントを付ける
  • 代名詞を避ける
  • 動作を正確に記述する
  • コードの意図を書く
  • 情報密度の高い言葉を使う