Marca de documentação <param>
A marca <param>
deve ser usada no comentário para uma declaração de método para descrever um dos parâmetros do método.
Sintaxe
/// <param name='param-name'>description</param>
Parâmetros
param-name
O nome do parâmetro de um método. Coloque o nome entre aspas simples ou duplas. O compilador emite um aviso se não encontrar param-name
.
description
Uma descrição do parâmetro.
Comentários
O texto da marcação <param>
será exibido no IntelliSense, no Pesquisador de Objetos e no relatório da Web de comentários sobre código.
Compile com /doc
para processar comentários de documentação em um arquivo.
Exemplo
// 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) {
}
};