Etiqueta de documentación <paramref>
La etiqueta <paramref>
ofrece una manera de indicar que una palabra es un parámetro. El archivo XML se puede procesar para dar formato a este parámetro de una forma exclusiva.
Sintaxis
/// <paramref name="ref-name"/>
Parámetros
ref-name
Nombre del parámetro al que se hace referencia. Ponga el nombre entre comillas simples o dobles. El compilador emite una advertencia si no encuentra ref-name
.
Comentarios
Compile con /doc
para procesar los comentarios de documentación a un archivo.
Ejemplo
// xml_paramref_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_paramref_tag.dll
/// Text for class MyClass.
public ref class MyClass {
/// <summary>MyMethod is a method in the MyClass class.
/// The <paramref name="Int1"/> parameter takes a number.
/// </summary>
void MyMethod(int Int1) {}
};
Consulte también
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de