. net工具到文档方法

本文关键字：方法 文档 工具 net | 更新日期: 2023-09-27 18:05:10

公司要求我记录所有。net web服务，并为这些服务的所有方法提供签名(即输入和输出)。是否有工具可以做到这一点并返回文档或摘要。这将为我节省大量时间，并使我不必浏览一堆代码。

谢谢!

. net工具到文档方法

我们在这方面使用氧气非常成功。

您可以像这样为方法添加XML注释:

    /// <summary>
    /// Method summary.
    /// </summary>
    /// <param name = "asdf">Parameter description.</param>
    /// <returns>Return value summary.</returns>
    public object SomeMethod(object asdf) {
        return null; // but really, do something fun
    }

GhostDoc是一个很好的开始记录未记录的代码。

XML文档然后可以通过SandCastle帮助文件生成器(SandCastle的一个很好的UI前端)导出，从而产生HTMLHelp, HTML和MS帮助文件查看器输出。

沙堡。请看快速操作指南。Sandcastle帮助文件生成器非常有用。

Sandcastle创建类似msdn的文档。我们在Visual Studio中使用GhostDoc对所有内容进行实际注释。

我认为Sancastle是最常用的。

其中包括:

  • NDoc
  • Docu
  • Doxygen

如果你的源代码中没有XML注释，GhostDoc插件在生成标准样板注释方面提供了很大的帮助，这些注释可以在以后修改。

相关文章：