1 可自动添加文档注释的插件
Atomineer Pro Documentation for Visual Studio
single-user license,76美元
visual assist x
2 visual studio可通过/doc编译选项生成xml格式的代码,然后通过sandcastle等工具处理生成api文档
3 visual studio推荐的xml注释标记
<c> | <code> | <example> |
<exception>1 | <include>1 | <list> |
<para> | <param>1 | <paramref>1 |
<permission>1 | <remarks> | <returns> |
<see>1 | <seealso>1 | <summary> |
summary用来添加给类添加注释,para用来增加一行。
// xml_summary_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_summary_tag.dll
/// Text for class MyClass.
public ref class MyClass {
public:
/// <summary>MyMethod is a method in the MyClass class.
/// <para>Here's how you could make a second paragraph in a description. <see cref="System::Console::WriteLine"/> for information about output statements.</para>
/// <seealso cref="MyClass::MyMethod2"/>
/// </summary>
void MyMethod(int Int1) {}
/// text
void MyMethod2() {}
};
param用来说明参数,name用单引号或者双引号指明函数参数,如果函数参数名称不正确,将出现编译错误。
// xml_param_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_param_tag.dll
/// Text for class MyClass.
public ref class MyClass {
/// <param name="Int1">Used to indicate status.</param>
void MyMethod(int Int1) {
}
};