我很喜欢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文档)。我只是想这样,这样我和另一个人看代码可以看到一些简洁和统一的注释,每个函数
创建一个代码片段,使用键盘快捷键包含您自己的注释样式。
代码片段编辑器是一个方便的工具。
然而,如果其他用户习惯了在Visual studio和c#中工作,那么他们会在看到XML结构以外的任何其他注释方式时感到困惑。
技术上有一种方法可以做到这一点,但是你需要自己为Visual Studio编写一个扩展,以便在VS中可视化地格式化XML注释,同时在源文件中保持原始格式。
类似于这篇XML评论文章末尾的基于wpf的查看器(我相信这只是一个内部原型)。
我还没有在Visual Studio Gallery中看到这样的扩展。也许最接近的概念是ItalicComments,但这不是你要的。