C#中如何在XML文档注释中正确引用类成员?
问题解答
这种引用方式不正确。
<paramref>标签的作用是引用方法的参数,但MyInt是类的字段,并非PrintValueOfMyInt方法的参数,所以用这个标签不合适。同时原代码里的<paramref name="MyInt">未正确闭合,也会导致注释格式错误。
正确的做法是使用<see>标签来引用类成员,示例如下:
/// <summary> /// Prints out the value of <see cref="MyInt" /> /// </summary> public void PrintValueOfMyInt() { ... }
<see>标签的cref属性可以让IDE智能识别类成员,生成文档时也能正确关联到MyInt的定义,同时要保证标签是自闭合的格式(/>结尾)。
内容的提问来源于stack exchange,提问作者anaotha
相关产品推荐
相关产品推荐

