Upgrade to Pro — share decks privately, control downloads, hide ads and more …

良いコードとは 研修

techtekt
August 25, 2023

 良いコードとは 研修

パーソルキャリア株式会社 テクノロジー本部 エンジニアリング統括部 サービス開発部
※本資料は2023年3月時点の情報であり、当該部門における2023年新卒の研修教材です。

techtekt

August 25, 2023
Tweet

More Decks by techtekt

Other Decks in Programming

Transcript

  1. 良いコードとは? • 保守性が高い • 正確に動作する • 無駄な部分がない • 効率的に動作する などなど

    縣 俊貴.『良いコードを書く技術── 読みやすく保守しやすいプログラミング作法』. 技術評論社.2021年,24p
  2. 他に良いコードと言われて浮かぶもの • 誰でも簡単に理解できるようなコードであること(可読性) • 新しい機能を追加することが容易であること(拡張性) • セキュリティが確保されている ◦ 潜在的な脆弱性がないこと 簡単に言えば、

    読みやすくて、理解しやすくて、修正しやすいコード • コードスタイルの一貫性を確保する • コードの中に「後でやる」「要修正」などの コメントが存在しない • 変数名やコメントのルールが一貫している
  3. 英語で命名されていること • 和製英語を使わない • スペルミスに注意 • 誤訳に注意 VS CodeならCode Spell

    Checkerのようにタイポを発見してくれるツールもある 昔見たことあるのは、記事が保存さ れるテーブルで、名称はkijis
  4. リファクタリング メンテナンスしやすくなるように、ソースコードを書き換えていく作業のこと リファクタリングをする時は • リファクタリングと機能改変を同時には行わない。リファクタリングをしてから新しい機能を追加 する。 • テストの追加をしない(テストケース漏れの追加, インターフェース変更への対象は例外) •

    リファクタリングを始める前と後にはユニットテストを実行しコードの機能が変更ないかを確認す る。 • パフォーマンスよりもメンテナンス性を重視する。 • 小さなリファクタリングとテストの組み合わせを繰り返す。一度に大きなリファクタリングをしな い。
  5. 参考書籍 • リーダブルコード ◦ www.amazon.co.jp/dp/4873115655 • リファクタリング ◦ www.amazon.co.jp/dp/4274224546 •

    Clean Architecture ◦ www.amazon.co.jp/dp/B07FSBHS2V • 良いコード/悪いコードで学ぶ設計入門 ◦ www.amazon.co.jp/dp/4297127830 • 良いコードを書く技術 ◦ www.amazon.co.jp/dp/4297120488 • Good Code, Bad Code ◦ www.amazon.co.jp/dp/4798068160