【发布时间】：2017-08-16 13:18:27
【问题描述】：
我正在使用包含层（API、域、存储库、DTO、实体）的 Web API 项目。我想为每一层记录我的源代码。 我已经开始评论每一层的每一个功能。这是一个好方法吗？ 哪个是为我的源代码（c# 项目）创建和维护准确、专业质量文档的最佳技术或工具。
【问题讨论】：
标签： c# code-documentation
【发布时间】：2017-08-16 13:18:27
【问题描述】：
最好确实以 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 的 cmets 时，您还可以使用不同的工具来生成完整的文档。我个人使用过doxygen。它是一个工具，可以根据代码中的 cmets 和摘要生成完整的 HTML 文档。
【讨论】：