2

何年もの間、XML ドキュメントをソース コードにインラインで格納し、「緑の海」を我慢してきましたが<include file="..." path="..."/>、Visual Studio でドキュメントを独自の XML ファイルに移動するために使用できるディレクティブについて最近知りました。ヘルプ ファイル生成用の Sandcastle などと同様に、Intellisense はこの方法を使用しても機能するようです。

コードが大量のドキュメントの下に埋もれてしまう「緑の海」の問題を他の人がどのように処理しているのか疑問に思っていました。XML ドキュメントを別のファイルに移動し、コードの説明が必要な場合はインライン コメントを使用しますか?

長所

  • コード ファイルは、より「クリーン」になります。
  • コードを参照して、特定のコード ブロック/メソッドを見つけやすくなります。

短所

  • インライン ドキュメントがない場合、見知らぬ人がコードを理解するのが難しくなる可能性があります。
  • ドキュメントがないと、XML ファイルのことを忘れてしまい、コードが変更されたときにドキュメントを更新しない傾向が生じる可能性があります。

http://msdn.microsoft.com/en-us/library/9h8dy30z.aspx

4

1 に答える 1

4

インラインのままにして、これらのVisual Studio - Command を使用してコードのすべてのセクションを折りたたむだけですか? 大きなファイルを見ているときにコードを折りたたんだり展開したりするコマンド。この場合、短所が長所を上回ると思います。あなたとあなたの仲間の開発者がドキュメンテーションに非常に熱心でない限り、その方法がうまく機能しているとは思えません。私が見たほとんどのコード ベースでは、ドキュメントが既に不足しているため、ドキュメントを追加することを難しくすることは、私の意見では悪い考えです。

于 2012-11-21T03:24:58.353 に答える