問題タブ [readability]

これは、私が多くの熱くて蒸し暑いコーディング セッションで遭遇した、長期にわたる問題でした。

ある人はこのようにコーディングし、別の人はそのようにコーディングします。それで、多くのプッシュとプルの後、私は興味があります.PHPの「IF ELSE」ステートメントを表現する正しい方法はありますか?

個人的に私は以下を使用します：

多くの議論の後、次のような他のオプションが提示されましたが、

また

また

コード ドキュメントに関しては、通常、コードはそれ自体を説明する必要があり、インライン コード ドキュメント (パブリック API ドキュメントを除く) は、回避策、特定の実装が選択された理由の説明などのメタコードの問題のみを説明する必要があることが認められています。

コードをより読みやすく、より説明しやすくするにはどうすればよいでしょうか?

---

編集: 一般的なコメントに加えて、具体的なヒントも探しています。したがって、「短くても意味のある変数名」と言う場合は、役立つヒントも得られるとよいでしょう (たとえば、「3 単語の原則を使用する」)。

これは個人の好みによると思いますが、あなたならどちらに行きますか？

対。

または、これをまったく実行せず、代わりに HtmlTextWriter クラスを使用する必要がありますか?

編集：いくつかの本当に良い提案がここにあります。2.0 フレームワークを使用しているため、LINQ は使用できません

重複の可能性:
T-SQL キーワードに大文字を使用する正当な理由はありますか?

簡単な質問です。個人的には、大文字の文字列よりも小文字の文字列の方が読みやすいと思います。SQLの大文字と小文字を区別する古い/人気のあるフレーバーはありますか?

参考のため：

対。

私には前者の方がはるかに読みやすいように思えますが、後者の方がより頻繁に見られます。

このJavascriptコードをリファクタリングするのを手伝ってください。スケジュールされたメッセージ送信には大きな形式があります（送信日、繰り返しタイプ、日付/数量で終了、クレジットシステム-実行時にスケジュールされた送信プランの総コストをカウントする必要があります）。このフォームのJavascriptバリデーターを書いています。

検証アルゴリズムがあります1）送信日時が過去の瞬間にないかどうかを確認します2）「日付で終了」フィールド時間が最初の送信日時よりも大きいかどうかを確認します3）スケジュール計画の総コストを検証します

（約6つのステップがありますが、ここに3つだけ記述します-問題を把握するのに十分だと思います）

「スケジュールされたプランを保存」ボタンには、「クリック」イベントのJavaScriptリスナーがあります。このリスナーはこの関数を呼び出します。

これがその宣言です：

後でリクエストをネストしました：

そしてもう1つここに：

私はそのアプローチが好きではありません。アルゴリズムを一目で理解するのは非常に難しいからです。たぶん、単一のフォームの検証のために多くの（約6）ネストされたAJAXクエリを作成するのは良くありませんか？たぶんそれは単一のリクエストにマージされるべきであり、その後、サーバー側ですべての検証アクティビティを実行しますか？このコードをどのようにリファクタリングする必要がありますか？

正規表現を使用するとコードの保守性が低下すると感じ始めました。正規表現の簡潔さと強力さには、どこか悪いところがあります。Perl は、これにデフォルト オペレータのような副作用を加えます。

私は、基本的な意図を示す少なくとも 1 つの文と、一致するものの少なくとも 1 つの例を含む正規表現を文書化する習慣があります。

正規表現は構築されているため、式の各要素の最大のコンポーネントについてコメントすることは絶対に必要だと思います。それにもかかわらず、私自身の正規表現でさえ、クリンゴン語を読んでいるかのように頭を悩ませています。

意図的に正規表現を控えめにしていますか? おそらく短くて強力なものをより単純なステップに分解しますか? 正規表現のネストをあきらめました。保守性の問題のために避けている正規表現構造はありますか?

この例で質問を曇らせないでください。

マイケル・アッシュによる次の記事に何らかのバグがあった場合、それを完全に破棄する以外に何かをする可能性はありますか?

リクエストごとに、上記のアッシュ氏のリンクを使用して正確な目的を見つけることができます。

一致01.1.02 | 2001 年 11 月 30 日 | 2000/2/29

不一致02/29/01 | 2002/01/13 | 11/00/02

RegOpenKeyEx()

関数が失敗したか成功したかによって、printf("Success") または printf("Failure") を使用したい

きちんと読みやすく保ちながら、このような条件をどのように行うのでしょうか?

私はこれから離れたいと思っています：

object.ReferenceEqualsメソッドを使用する場合と使用する場合に余分なオーバーヘッドはあり((object)obj1 == (object)obj2)ますか?

最初のケースでは、静的メソッド呼び出しが関係し、どちらの場合もオブジェクトへの何らかの形式のキャストが関係します。

コンパイラがこれらの方法のバランスを取ったとしても、不等式はどうなるでしょうか?

と比較して...

ある時点で、!= 演算子内で、または ReferenceEquals メソッドの結果に適用されると、論理否定が発生すると思います。どう思いますか？

考慮すべき読みやすさの問題もあります。ReferenceEquals は、等値をチェックする場合により明確に見えますが、不等値の場合、!前の を見逃す可能性がobject.ReferenceEqualsあります!=が、最初のバリエーションの は見逃せません。

PHP の関数宣言キーワードに関するマイナー ポイント: 静的なクラス メソッドがある場合、staticキーワードは可視性キーワード ( public, protected, private) の前または後に来る必要がありますか? static であろうとなかろうと、すべてのメソッドに可視性キーワードがあると仮定すると、可視性キーワードをキーワードに対して同じ場所に残す必要がありますfunction。

ここで、カップルが静的であると仮定します。

また、メソッドが static である場合は、それが最初に表示されるようにする必要があります。これは、可視性キーワードよりもメソッドの種類に大きな影響を与えるためです。

これは厳密には読みやすさの問題であり、明らかに機能上または設計上の影響はありません。（私が考えることができる。）