読みやすいコードを書く技術

読みやすいコードを書く技術いんてる@沖縄学⽣×企業エンジニア 7⽉⼤LT⼤会 © 2018 Chura DATA inc. PROPRIETARY &
CONFIDENTIAL.

みなさんに質問があります︕

コーディング好きな⼈挙⼿!

コーディング楽しいよね • 様々な問題を解決するために、みなさんはプログラミング⾔語をつかってコーディングをしているはず。 • コーディングに夢中になってつい数時間かけちゃうのも気にならない。

さらにもう⼀つ質問です︕

⾃分のコードを他⼈に⾃信を持って薦められますか︖!

なぜ数が減ったのか • 「⾃分のコード汚いし・・・」 • 「変数名適切につけてる⾃信ない・・・」 • 「半年前に書いたコード、⾃分が読んでもよくわからない・・・」

共通点は「オレオレ流コーディング」 • ⾔い換えれば「⾃分⽤に最適化された⼀番いい⽅法でコーディング」しているということ。 → このときコードの主軸が⾃分になっているため、他⼈に⾃信をもって薦められない・・・

読みやすいコードを書く技術 • 他⼈に薦められるコードを書くためには︖ • 誰にでも読めるコードであること • 構造が複雑でなくシンプルであること • ⼀⽬でプログラムの⽬的がわかること •
etc...

AGENDA • リンターを使ってみよう • リンターって何︖ • ビフォーアフター • リンターによって何が改善されるか⾒てみましょう •
まとめ今⽇話すこと

遅れてやってくる事故紹介 • いんてる (@Intel0tw5727) • ちゅらデータ株式会社新卒1年⽬ • 普段はPythonでデータ分析とか画像処理してます
• PyCon Kyushu in Okinawa の実⾏委員⻑とかしてました。 • 最近は三度の飯より筋⾁が好きです。

企業理念 make a future - 次の常識をつくるわたしたちは『最⾼に⾯⽩い仕事』を沖縄に創りたい︕という想いのもと創業しました。沖縄の労働問題をぶち破り、「⾼賃⾦」で「最先端かつやりがいのある」仕事を「最⾼の仲間」
と⼀緒に創り上げることを⽬指しています。社員それぞれが誇りを持って仕事を楽しめる場所であること、それがわたしたちの理想です。 © 2019 Chura DATA inc. PROPRIETARY & CONFIDENTIAL. ‹#›

リンターを使ってみよう

リンターってなーに︖ • 簡素に⾔うと「厳密な構⽂チェッカー」 • いわば「各々の書くコードの書き⽅の基礎的なところを統⼀しましょう」というもの。 • リンターに則って書くことで、⾃然と⼀般的な書き⽅が⾝につくというもの。

例︓Python の場合 • pycodestyle(旧pep8) • 「コードは書かれる時間よりもずっと多くの時間読まれる」ということから「コードに⼀貫性」をもたせようというガイドライン。 • pylint •
pep8より古くからあるリンターで、pep8にはない様々なチェック項⽬とオプションを持つガイドライン

ビフォーアフター

⼈⽣初ライブコーディング • 5分弱で収まる気がしないですがやります。 • コードは⾃分が学部2年の頃に書いた、「画像を回転させてデータのかさ増しを⾏うスクリプト」です。

Let's Live coding!!

今回のポイント • ちゃんと各関数にはどういうことをやるのか書こうね。 (Docstringをきちんと書きましょう。引数や返り値の詳細もね。) • 変数名は省略せずきちんと書きましょう (readImgとかfolderとか⼀⽬で⾒て何が⼊ってるかわからないのは良くない) • 1⾏が⻑くなるようなら複数⾏に分けたり、
⼀旦変数に格納したりしましょう。

これ以外にもたくさん項⽬はあります︕ • 各関数内で使⽤する変数名は15個以内にしましょう • インポートは「標準ライブラリ・外部ライブラリ・⾃作モジュール」の順番に記載しましょう。 • etc.

まとめ

読みやすいコード = コードに⼀貫性がある • 共通した書き⽅に則るために、リンターというガイドラインをつかうことで誰が⾒ても読めるコードになる。 • ⼀⾒めんどくさいように⾒えるけど、リンターを通す通さないでは今後のチーム開発でかなり差が出ます。 •
他⼈のコードを読んで修正することが学⽣のころよりも圧倒的に増えます。 • なによりバグが発⽣したときに⼀⽬で発⾒しやすい • エラーが出た際に箇所を特定しやすく、関数⽬的が明確なため、修正しなければいけないところを抑えやすい。

ご静聴ありがとうございました︕

(時間あってもなくても)宣伝

申し訳程度の宣伝 • ちゅらデータ株式会社ではサマーインターンを参加学⽣を募集しています︕ • 今回はUnityとPythonで深層強化学習にチャレンジして頂きます︕ • 応募詳細はtwitterに流しますので、 @intel0tw5727
を要チェック︕

読みやすいコードを書く技術

読みやすいコードを書く技術

Intel0tw5727

More Decks by Intel0tw5727

Other Decks in Education

Featured

Transcript