。文档方法的网络工具

Question

我的公司已经要求我记录我们的所有.Net Web服务，并为这些服务的所有方法提供签名（即输入和输出）。是否有工具可以做到这一点，并返回文档或摘要。这将为我节省很多时间，并阻止我查看一堆代码。

谢谢！

Answer 1

我们使用Doxygen为此取得了相当不错的成功。你可以看到从this page链接的例子。

Answer 2

Sandcastle。 请参阅this快速操作指南。 Sandcastle Help File Builder非常有用。

Sandcastle创建msdn文档。我们在Visual Studio中使用GhostDoc来对所有内容进行实际评论。

Answer 3

您可以添加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 
    } 

Answer 4

GhostDoc是伟大的得到一个初步的开始记录无证代码。

XML文档然后可以通过SandCastle Help File Builder（一个Sandcastle的良好UI前端）导出，从而生成HTMLHelp，HTML和MS帮助文件查看器输出。

Answer 5

Sancastle是我认为最常用的一个。

除其他还有：

• NDoc
• Docu
• Doxygen

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