問題タブ [code-readability]

SQLクエリに長いフィールドがある場合、どのようにして読みやすくしますか？

例えば：

この質問はある程度好みの問題であることは承知しています。これは私が理解できないことではなく、他の人の意見を聞きたいだけであることは認めます。

ブール値と文字列の 2 つの引数を取るメソッドを作成する必要があります。ブール値はある意味では (すぐに明らかになるでしょう) 冗長ですが、メソッドが両方の引数を受け取る必要があり、ブール値が「間違った」値を持つ場合は特定のメッセージ テキストで例外を発生させる必要があるという仕様の一部です。 . bool は、文字列が null または空でないtrue 場合にのみ指定する必要があります。

そこで、同じことを (できれば!) 書くためのいくつかの異なるスタイルを示します。どれが最も読みやすく、優れたコーディング プラクティスに準拠していると思いますか?

もちろん、他の可能性を提案することも大歓迎です。メッセージ テキスト"..."は、「'useName' が true の場合、名前を指定する必要があり、'useName' が false の場合、名前は許可されません」のようなものになります。

重複の可能性：
HTMLの空白を無視する

ウェブページに画像を並べて表示しようとしています。これが私のHTMLです：

しかし、私のWebページでは、これは各画像間のギャップを示しています。要素を分離して読みやすくする戻り行を削除し、代わりにすべての要素を1行に配置すると、ギャップがなくなることに気付きました。

とにかく後者の出力を達成できますが、コード/入力は前者のように見えますか？戻り行（スペースを入力）がコードにもたらす読みやすさは本当に気に入っていますが、実際のページに空白が作成されることは望ましくありません。誰かがこれがなぜであるか、そして/またはそれを修正する方法を説明することができれば、私は本当に感謝するでしょう！:)

高度にインタラクティブでアニメーション化されたクライアント側 Web アプリケーションで作業している間、私たちは jQuery ライブラリに大きく依存し、それらのイベントを多用しています。

大規模なエンタープライズ アプリケーションでは、これにより、イベント、そのコールバック、さらには 4 桁のコード行の内部メソッド呼び出しが大きく結び付けられます。それは、麺で満たされた巨大な容器や、デバッグが難しい goto ラベルでいっぱいの巨大なプログラムのように見え始めます。

私の質問は、イベント、コールバック、および関連する手順を、よりクリーンで読みやすく、保守しやすい方法で配置するにはどうすればよいかということです。Java では、これを処理するためにさまざまなデザイン パターンと個別のクラスを使用できます。JavaScriptでそれをどのように達成できますか。

前もって感謝します。ほんの一握りのリンクも高く評価されます

この CMIS リモート ファイルの CmisDocument を取得したい: server1/dir1/file1.

用の CmisFolder を既に持っていますserver1/dir1。
ファイル名も"file1"文字列として持っています。

CmisDocument を取得するエレガントな方法はありますか?

以下は私の非常に洗練されていない試みです:

次の例に基づいています。

メンバー メソッドを呼び出していることをより明確にする方法はありますか (setLocation()およびを参照setSize())。

this.setLocation()宇宙からのものではなく、メンバーメソッドを呼び出すことを明示するために、の行で何かを探しています。

過去 3 か月から煎茶アプリケーションを開発しています。

アプリケーションソースにはいくつかの JS ファイルが含まれており、各ファイルには平均で 800 ～ 1000 行のコードが含まれています。コードは完全に厄介です。必要のないデッドで到達不能なコードが少なくとも 20% 含まれています。

ここでのタスクは、すべてをクリーンアップし、コードを理解しやすく保守しやすくすることです。誰かが機能を変更するように言った場合、コード内で変更を追加できる適切な場所を見つけるのに苦労しています。このような状況で、目の前のタスクにどのように取り組むべきですか?

私の努力を楽にする自動化ツールの助けをきっと探しています。前もって感謝します。

RDFa を追加するのはとても楽しいのですが、ソースを読むのがほとんど不可能になる傾向があります (エディタの構文強調表示が適切であっても)。たとえば、次のようになります。

私は一般的に密なマークアップが嫌いなので、マークダウンで書くことを好むことがよくありますが、この例のような RDFa マークアップを追加するコンテキストでは、これは不可能に思えます。

これをもう少し人間が読めるようにするために空白を悪用するかもしれないようです。このための既存のツールや規則はありますか? (以下の例は!fmt、vim でのワードラップからのもので、通常は適切に見えますが、この場合は途方に暮れているように見えます)。

私はApache log4j（http://logging.apache.org/log4j/2.x/）を使用していますが、実装では常に次のように関数を宣言していることに気付きました：

それ以外の

このスタイルを使用する正当な理由はありますか?

2つ以上のオプションから選択できるので、結果/結果が同じである場合、どちらを選択するかという質問につながります。

次の条件で.NET C# は、異なる演算子を使用して同じ質問をしているので、質問は、経験豊富な開発者が何を使用するかということEqualsです。

いつ、なぜあなたは「伝統的な」よりも、そして両方を選ぶ!のEqualsです ==か？