注意！こんなプログラマーは嫌われます！コーディング・エチケットをチェックしてムダなイライラを最小限に！

みなさんは、Webサイトやアプリのコードのエラーを検索するのに何時間も費やした経験はないでしょうか。

他の開発者と一緒に開発するとき、そうでなくても自分の時間を無駄にしないためにも、きれいで管理しやすいコードを書くちょっとした工夫をルールを守れば、相当なエラーを防ぐことが出来ます。しかもそれはかなり簡単です。

本記事では、なにかと犯しがちなミスとその対処法をいくつかご紹介することで、同じ誤りで何年もの時間が無駄になるのを防ぎたいと思います。

 

 

０．コードにコメントをつけよう

 

コメントがつけられていないコードほど悪いものもありません。コードを改善するために何かをするつもりなら、まずはきっちりと自分の書いたコードにコメントするようにしましょう。大声で誇りを持ってコメントしてください。

たとえば、ちょうど大きな、ゲーム・チェンジャーになるような機能を仕上げたとしましょう。それが何をし、どのようにそれを使用するかをタイプしてください。そうすれば、 6ヵ月後には自分自身に感謝することになるし、同僚から詰問される心配もなくなります。

 

 

１．コメントを実際に作ってみます

 

コメントの注意点としては、コメントが、実際に何が実際に起こっているかを仲間のプログラマーに明確かつ簡潔な方法で伝えることが重要になります。覚えておくべきは、人はみなそれぞれ異なった仕方で考えるということです。

しかし同時に、自明なものを再現することは避けるべきです。以下の例を考えてみましょう。

初心者にとってさえ基本的で明確なものであれば、コメントしてはいけません。

 

 

２．どこにも騒がしくない

 

堅実な、記述的な変数名を使用してください。コードがコード自身に言及するような仕方でコメントすべきです。つまり、変数には、変数や変数の名前が付けられます。あなたの好きなトランスフォーマーではありません。

これを見てそのコードブロックが何をしているかわかるでしょうか。メガトロンって何？

同じ原則が短い変数名に適用されます。受け入れられた標準略語を使用している場合を除き、完全な単語を使用してください。後であなたのコードを読んでいるプログラマーが、ランダムな文字で混乱しないようにです。

これなら理解できます。

この調子なら、正しい軌道に乗ったと言えます。

 

 

３．入れ子を活用する

 

あなたがコメントは、階層が明確になるようにコードブロックをネストします。適切にネストされたHTMLは、適切なCSSセレクタが使いやすくなります。

さてバグを見つけてください。

もう一度。

インスペクタでデベロッパーツールがあなたのコードをインデントしたがるかもしれませんが、ネストしなければ、誰がどうやってエラーを見つけられるでしょか。

 

 

４．コミュニティ基準に従う

 

以上が最低限ですが、まだ不十分です。Django、jQueryのいずれの開発コミュニティにも、独自のコーディング標準があります。それらには従うことです。

特定のコミュニティでプログラマーとしての評判を失う最も速い方法は、受け入れられた基準を無視することです。あなたがあまりにも邪魔になる前に、常に基準をチェックしてください。いったん悪いコーディング習慣を持つと、破るのは非常に難しいです。

・WordPressの標準について詳しくは、WordPressコーデックスを参照してください。

・Pythonの標準については、「PEP 8スタイルガイド」を参照してください。

・他の言語については、Googleをご覧ください。

 

 

５．そして最後に：楽しむ

 

プログラミングは、スーツを着る必要はないし、毎日髭をそらなくてもいい偉大な職業の一つです。そして、文字通り世界を変えるもので、信じられないことをコードで行うことができます。つまり、楽しいはずなのです。

しかし、あなたが残した1つのバグのために、2,000行のCSSを点検する作業を楽しむことは難しいでしょう。

以上にご紹介した基本を踏襲すれば、そんな時間を最小限にすることができます。

 

 

※本記事は、Coding Etiquette to Make Other Developers Hate You Lessを翻訳・再構成したものです。

 

 

▼こちらの記事もおすすめです！