visual studio c++添加文檔註釋,生成api文檔

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>

<value>

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) {
   }
};

 

發佈了74 篇原創文章 · 獲贊 11 · 訪問量 4萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章