人間が読めるコードを作成するための基本的な標準や実践方法はありますか?

Question

具体的には、HTML、Java、Python を読みやすくすることですか?このプログラミング学生に何か提案がある人はいますか?

Answer 1

1. 一貫した大文字と小文字の区別と名前付けを使用します。

2. タブ (および使用可能な場合は括弧) を使用して、視覚的なフローを提供します。

3. 何が起こっているのかを概念的にも技術的にも説明するコメントを使用します。(例: // 有効なユーザーはいますか?not //user_ID が -1 でないことを確認してください)

経験豊富な開発者ならもっと多くの提案があると思いますが、これらが私のトップ 3 です。

Answer 2

適切なインデントと有益なコメントます。

Answer 3

使用インデント、コメントやコーディング規約（Python用は PEP8 を確認してください）

Answer 4

は必ずあなたのコードがうまく（適切なインデント、コードなどの別のセクションに空白行）と使用基準、一貫性のある構造化されていることを確認し、そして完全に変数名（むしろ不可解略しより）と命名ます。

その他の適切なコメントを使用してお勧めします。私は同意する傾向があります。あなたのコードはうまく構造化変数がうまく命名されている場合は、コメントだけで物事を煩雑にします。あなたはどこか別のバグを回避するには直感的に何かをしなければならないときであること規則の例外（私は過去にWCFとEntity Frameworkのコードでこれに頼らなければならなかった）。

Answer 5

大声であなたのコードを読み出すようにしてください（あるいは、少なくとも、あなたの頭の中で）ます。

Answer 6

クリーンコード：

この本を見て持っているアジャイルソフトウェアクラフトマンシップのハンドブックを。これは、すべてのコードが読みやすく、理解しやすい作りについてです。

Answer 7

アドバイスのワンピースは、名前の怠惰ではないです。あなたは、Transformerインタフェースの実装であるJavaクラスを持っている、そしてそれはStringにDateを変換した場合、クラスStringToDateTransformerImplに名前を付けることを躊躇しないでください。

Answer 8

さて、あなたは常に「無知テスト」を使用することができます。絶対にプログラム書き込みについて何も知らない誰かにあなたのコードを表示します。彼は、多かれ少なかれ機能が何を見ることができる場合は、コードはおそらく読み取り可能である。

Answer 9

書き込みHTMLを使用すると、ネストされた要素の任意の並べ替えと相互に作用している場合は特に、命の恩人することができ、適切なインデント。ただ、インデントと一致しているとあなたはインデント要素を移動または削除したときにラインを囲む更新してください。インデントのレベルは、あなたがCtrlキー+ F操縦のいくつかの並べ替えに頼ることなく、ページのどこにいるかのような手がかりを与えるので、これは、それははるかに簡単にページを更新できるようになります。

それはあなたがHTMLと一緒にCSSを使用している場合は、適切な命名が重要であることは注目にも価値があります！それはあなたのワークフローと、コードの可読性が向上します。

「本当の」（Javaの、パイソン、Cなど）のコードを書くときに

私はまた、インデント、間隔、およびコメントの大ファンです。私は個人的には読みやすさに大きな違いをもたらすと思うので、私は（X + 1）（X + 1）以上の方に傾きます。 Iなどのキャスト、刻み、アウトスペースと、彼らははるかに簡単に私の目をキャッチ。あなたのブラケット/インデントスタイルと一致して、コメントを自由に！ - 再書き込みメソッド名はコメントはありませんが、覚えておいてください。