使用C#的inheritdoc获取指定参数描述失败,能否实现该需求?
用提取指定参数描述到方法摘要的实现方案
可以实现,你当前的写法问题在于未精准提取参数描述的文本内容,导致继承了目标方法的整体注释而非指定参数的描述。调整select的XPath表达式即可解决:
原方法注释示例
/// <summary> /// 原方法的摘要内容 /// </summary> /// <param name="nameOfParameter">这是需要提取的目标参数描述</param> public void MethodName(int nameOfParameter) { // 方法逻辑 }
目标方法的正确注释写法
/// <summary> /// <inheritdoc cref="ClassName.MethodName" select="param[@name='nameOfParameter']/text()" /> /// </summary> public void AnotherFunc() { // 方法逻辑 }
关键说明
- 通过
select="param[@name='nameOfParameter']/text()"精准定位到目标参数的文本内容,避免继承目标方法的其他注释节点 - VS的IntelliSense、Sandcastle等主流文档工具均支持该XPath语法
- 若目标方法无
<summary>节点,也不会影响参数描述的提取,只要select表达式正确即可
内容的提问来源于stack exchange,提问作者Leon Frickenschmidt
相关产品推荐
相关产品推荐

