C＃プロジェクトのソースコードの品質に関する文書ですか？

Question

私は層（API、ドメイン、リポジトリ、DTO、エンティティ）を含むWeb APIプロジェクトで作業しています。各レイヤーのソースコードを文書化したい。 私は、各レイヤーの各機能についてコメントを始めました。それは良い方法ですか？ 私のソースコード（c＃プロジェクト）の正確で専門的な品質の文書を作成し維持するための最良の手法またはツールはどれですか。

Answer 1

ベストのように、XML形式で、あなたのコード内のすべてのメソッド/クラスのための要約を書くために実際にある：

/// <summary> 
/// This class performs an important function. 
/// </summary> 
public class MyClass{} 

さらに詳しい情報：https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments

これらのXMLベースのコメントを使用して、あなたがすることもできます完全なドキュメントを生成するために異なるツールを使用してください。個人的に私はDoxyGenを使用しました。これは、コード内のコメントと要約に基づいて完全なHTMLドキュメントを生成するツールです。