6

より具体的には、HTML、Java、および python をより読みやすくしますか? このプログラミングの学生に何か提案はありますか?

4

9 に答える 9

5

コードが適切に構造化されていること (適切なインデント、コードのセクションを区切るための空白行など) を確認し、標準的で一貫性のある完全な名前の (理解できない省略形ではなく) 変数名を使用してください。

適切なコメントを使用することを提案する人もいます。私は反対する傾向があります。コードが適切に構造化され、変数に適切な名前が付けられている場合、コメントは物事を混乱させるだけです。ルールの例外は、他の場所でバグを回避するために直観に反することをしなければならない場合です (私は過去に WCF および Entity Framework コードでこれに頼らなければなりませんでした)。

于 2010-09-28T12:46:39.907 に答える
5

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

于 2010-09-28T12:47:00.437 に答える
5

  1. 一貫性のある大文字と小文字と命名を使用します。

  2. タブ (および利用可能な場合はブラケット) を使用して、視覚的な流れを提供します。

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

ベテランの開発者にはもっと多くの提案があると思いますが、それらが私のトップ 3 です。

于 2010-09-28T12:47:54.960 に答える
5

インデント、コメント、およびコーディング規則を使用します (Python チェックPEP8の場合) 。

于 2010-09-28T12:47:59.700 に答える
3

コードを声に出して (または少なくとも頭の中で) 読んでみてください。

于 2010-09-28T12:50:09.150 に答える
3

次の本をご覧ください: Clean Code: a handbook of agile software craftsmanship。コードを読みやすく理解しやすいものにすることがすべてです。

于 2010-09-28T12:50:45.077 に答える
2

1 つのアドバイスは、名前を怠惰にしないことです。たとえば、Transformer インターフェースの実装である Java クラスがあり、それが に変換StringされるDate場合は、ためらわずにそのクラスに という名前を付けてStringToDateTransformerImplください。

于 2010-09-28T12:49:03.130 に答える
2

まあ、いつでも「無知なテスト」を使うことができます。プログラミングについてまったく知らない人にあなたのコードを見せてください。関数が何をするかを多かれ少なかれ理解できれば、コードはおそらく読み取り可能です。

于 2010-09-28T12:54:30.697 に答える
1

HTML を書くときの適切なインデントは、特に入れ子になった要素を操作しているときに命の恩人になる可能性があります。インデントに一貫性を持たせ、インデントされた要素を移動または削除するときは周囲の行を更新してください。これにより、ページの更新がはるかに簡単になります。インデントのレベルによって、何らかの Ctrl+F 操作に頼ることなく、ページ内のどこにいるかの手がかりが得られるからです。

また、CSS を HTML と組み合わせて使用​​している場合は、適切な名前を付けることが重要です。これにより、ワークフローとコードの読みやすさが向上します。

また、「本物の」コード (Java、Python、C など) を書くときは、インデント、スペース、およびコメントの大ファンでもあります。(x+1) より (x + 1) の方が読みやすさに大きな違いがあると個人的に思うからです。キャストやインクリメントなどに間隔を空けると、はるかに簡単に目を引くことができます。ブラケット/インデント スタイルに一貫性を持たせ、自由にコメントしてください。メソッド名を書き直すことはコメントではないことに注意してください。

于 2010-09-28T13:47:30.113 に答える