[C/C++] 주석으로 함수 매개변수 설명 추가하는 방법

<param> 설명서 태그

<param> 태그는 메서드의 매개 변수 중 하나를 설명하기 위해 메서드 선언에 대한 주석에서 사용해야한다.

/// <param name="Int1">Used to indicate status.</param>

 

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

doxygen style

// @param val 값
void Fn(int val)
{
}

 

<param> (C++ 설명서 주석) | Microsoft Learn