問題タブ [code-readability]

次のようなコードのセクションがあります。

しかし、私の例外は、それがどの特定の呼び出しから来たのかを示しています。スタックトレースには、関数呼び出し内から呼び出された別のクラスの詳細のみが表示されます。

これをラップする別の方法は次のとおりです。

以前のバージョンよりもはるかに読みにくいと思いますが。

コードを読みやすくしながら、後でどこから来たのかを確認できるように、関数呼び出しをラップしたり、例外を渡すパターンはありますか？

C++ では、関数を呼び出す前に宣言する必要がありました。これは関数シグネチャで回避できますが、ほとんどの場合、これは新しいプログラミング言語 (C#、Python、ETC) では不要になりました。

しかし、他の人やコードを読んだり、クラス内で関数を構造化しなければならないときに、C++ に存在する一貫性が欠けていることに気付きます。

コードの構造について読みやすさと理解を維持しながら、関数を宣言/順序付けするためにどのようなパターンが存在しますか?

編集 1

これが大まかな例です。

対

編集 2

これは、エディターに関係なくコードを記述するためのガイドラインになります。新しいエディタには優れた「定義に移動」機能があり、ブックマークもこれに役立ちます。ただし、エディターに依存しないパターンに興味があります。

誰もがより読みやすいコードの利点を知っています。したがって、コードを読みやすくするために、私が通常行うことは、コメント付きのクラス宣言をそのクラスの実装ファイルに含めることです。
このようにして、定義に移動するためにさまざまなインクルードディレクトリを参照する必要はありません。
それで、これは良い習慣ですか、それとも単に過剰な文書化ですか？
標準的な手法がある場合は、plzからお知らせください。
編集：
Vimでの実装からクラス宣言に移行する方法はありますか？
新しいバッファで開くことを除いて。

ありがとう

ここで、このばかばかしいほど醜いメソッドをクリーンアップしようとしています。これはリファクタリングを求めていますが、どのような構造がこれに最適なのかわかりません (つまり、case ステートメント、または単に慎重にフォーマットされたif thenステートメント) 。

一見すると、適切に配置されたいくつかwhenの 's を持つ case ステートメントの理想的な場所のように見えますが、私の理解では、case ステートメントは 2 つではなく 1 つの変数に対してのみ使用でき、irb をさまざまにいじることができます。ハッシュまたは配列を使用してこれらのステートメントを試すことは、ここでもあまり光を当てていません。

これをどのように行いますか？このような複数のブール値をチェックするときに、このようなコードを回避するための Ruby の一般的なトリックはありますか?

WPFを使用しているときに、XAMLとデザイナーを切り替えます。これにより、各要素の属性の順序が異なり、すべてを手動で並べ替えない限り、コードが読みにくくなります。

これを行う簡単な方法はありますか？

私はCSSとHTMLの知識はありますが、プログラミングの完全な初心者です。

Pythonを学びたいです。私はたくさんのソースコードをダウンロードしましたが、ファイルの量と複雑さは本当に私を混乱させます。どこから始めたらいいのかわからない。私が探すべき特定の注文はありますか？

ありがとう。

編集：申し訳ありませんが、私はすでにオンラインチュートリアルと数冊の本の両方を手元に置いていることを言及するのを忘れました。私は基本的に、プログラミングの技術や概念を理解するために、複雑なソースコードを「解体」して理解する方法を完全には理解していません。

EDIT2：非常に迅速なコメントをありがとう、みんな。ほんとうにありがとう。このウェブサイトは素晴らしいです。

とは対照的に：

と

とは対照的に：

if(false == ... バージョンの方が読みやすいと思います。同意しますか、それとも提案できる別のトリックがありますか?それは同じくらい速くなりますか?ありがとう。

これが私が !x を好まない理由です:

以下はより良いようです：

＆をきちんとどこに置けばいいのかしら。

コードベースのC++コードを再フォーマットするためにWindowsで動作するツールを探しています。基本的に、少し前に書いたコードを使用したいのですが、最近のプロジェクトで使用しているスタイルと一致しません。

標準的な方法でC++コードを再フォーマットするための最良の方法は何ですか？

ビリー3

現在、正式な調査レポートを作成しており、このレポートにコードを含める予定です。

質問:調査レポートにコードを表示する方法として認められているものはありますか? フォント、スペースなどの点と、コードをドキュメント内に表示するか、付録に表示するかの両方について考えています。

コードは JavaScript と PHP になります。コードのどのセクションも 25 行を超えることはありません (したがって、これらは単なるスニペットです)。約半ダースのスニペットがあります。各スニペットには、コードで何が起こっているかを説明するいくつかの段落と、その長所/短所に関する議論があります。

私は報告書の提出先の組織と連絡を取り合っておらず、コードのフォーマット方法に関するガイドラインも公開していません (これらの点について質問しないでください)。