Microsoft 中的函数描述符 Visual Studio

Question

我已经使用微软 visual studio 一段时间了，刚刚发现您可以为函数提供参数说明。但我也希望能够对函数使用类似 pre 和 post 的描述，这可能吗？

了解信息；

我正在使用 Microsoft visual studio（如前所述）
使用 C++，但如果它也适用于其他编程语言就更好了

/**
* This the version of quicksort that actually performs partitioning, recursive calls, etc.
*
* @param ar = pointer til arrayet
* @param start = sted man skal starte med at sorte
* @param end = stedet sorting skal slutte
* 
* @pre gets an unsorted array
* 
*/
template<typename T>
void quicksort(T* ar, int start, int end)
{
    // if (base case reached) return;  // Base case: No sorting necessary 

    // select pivot index and position pivot;
    // partition ar[start; end];

    // Assume: Pivot is at index k after partitioning 
    // quicksort(ar, start, k - 1);
    // quicksort(ar, k + 1, end);
}

How it looks with parameter descriptions

我尝试在 google 上搜索，我可以看到一些关于 doxygen 和 xml 的文档，但我不确定如何让它工作。

Answer 1

XML输入“///”后自动生成的文档在Visual Studio 2019 16.6及以后版本支持。举例如下：

我在<summary></summary>中输入了“输出一个字符”，所以下面的功能描述中出现了“输出一个字符”。

Microsoft 中的函数描述符 Visual Studio

Function descriptors in Microsoft Visual Studio

c++

visual-studio-2019