我正在使用包含图层（API，域，存储库，DTO，实体）的Web API项目。我想记录每个图层的源代码。 我已经开始评论每一层的每个功能。这是一个好方法吗？ 这是为我的源代码（c＃项目）创建和维护准确，专业的质量文档的最佳技术或工具。
答案 0 :(得分：2)
Best确实以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文档。