【问题标题】:Auto Comment (e.g. "///") but not in XML in Visual Studio 2012自动注释(例如“///”)但不是在 Visual Studio 2012 中的 XML
【发布时间】:2013-01-15 19:31:36
【问题描述】:

我很喜欢 Visual Studio 中的“///”功能,但我发现它以 XML 显示的事实令人迷惑。我更希望输出看起来像 javadocs:

/**
 * @author      Firstname Lastname <address @ example.com>
 * @version     1.6                 (current version number of program)
 * @since       2010-03-31          (version of the package this class was first added to)
 */

有什么方法可以实现吗?我不在乎数据可能无法在应用程序之外访问(例如自动生成的 API 文档)。我只是想要这个,以便我和另一个查看代码的人可以看到每个函数的一些简洁统一的 cmets。

【问题讨论】:

    标签: visual-studio-2012 comments auto-generate


    【解决方案1】:

    使用键盘快捷键创建一个片段以包含您自己的评论样式。

    Snippet editor 是一个方便的工具。

    但是,如果其他用户习惯于在 Visual Studio 和 C# 中工作,那么他们会因为查看除 XML 结构之外的任何其他评论方式而迷失方向。

    【讨论】:

      【解决方案2】:

      嗯,技术上有一种方法可以做到这一点,但您需要自己编写 Visual Studio 的扩展,以便在 VS 中直观地格式化 XML cmets,同时保持源文件中的原始格式。

      类似于this XML comments article 末尾的基于 WPF 的查看器(我相信这只是一个内部原型)。

      我在 Visual Studio 库中没有看到执行此操作的扩展。也许最接近概念的是ItalicComments,但这不是你想要的。

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2010-09-30
        • 1970-01-01
        • 1970-01-01
        • 2012-08-29
        • 1970-01-01
        相关资源
        最近更新 更多