Question

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

谢谢！

Answer 1

我们使用doxygen取得了相当不错的成功。您可以看到从this page链接的示例。

Answer 2

您可以向以下方法添加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 3

GhostDoc非常适合开始记录未记录的代码。

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

Answer 4

Sandcastle。有关快速操作方法的信息，请参阅this。 Sandcastle Help File Builder非常有用。

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

Answer 5

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

其中包括：

如果源代码中没有现有的XML注释，GhostDoc插件可以生成标准样板注释，可以在以后修改。

.Net工具到文档方法

5 个答案: