DocFX 生成字段文档 - 如何只生成字段而不生成方法文档
使用 DocFX 生成文档时,可以使用注释标记来指定要生成的文档内容。要让 DocFX 只生成字段文档而不生成方法文档,可以使用注释标记来指定要生成的文档内容。
在类的注释中,使用 <inheritdoc/> 标记来继承父类的注释,并使用 <member> 标记来指定要生成的成员文档。具体来说,你可以在类的注释中使用 <member name='F:Namespace.Class.FieldName'> 标记来指定要生成的字段文档。例如:
/// <inheritdoc/>
/// <member name='F:Namespace.Class.FieldName'>
public class MyClass
{
/// <summary>
/// This is a field.
/// </summary>
public int FieldName;
}
在这个例子中,<inheritdoc/> 标记继承了父类的注释,然后使用 <member> 标记指定了要生成的字段文档。在标记中,F:Namespace.Class.FieldName 表示要生成的是 MyClass 类的 FieldName 字段的文档。
当你使用 DocFX 生成文档时,只会生成指定的字段文档,而不会生成方法文档。
原文地址: https://www.cveoy.top/t/topic/qyPs 著作权归作者所有。请勿转载和采集!