A way to link to a class,a method, especially a specific code line in C# comment

天大地大妈咪最大 提交于 2019-12-04 19:27:08

问题


I want to build sort of documentation using links in code that point to a target. The target could be a Class or a Method or a specific code line. (pointing to a specific code line is the most important)
I thought of an extension for VS2010 or a specific comment tag.
Is there any way to make links of this kind ?


回答1:


Xml comment + sandcastle may be what you need. You can reference specified class or method using

<see cref=".."/>

and reference parameters using

<paramref name=".."/>

However, there is not direct method to reference certain lines of code but you can reference certain #region by using

<code source="$sourcefile$" region="$regionname$"/>

Please refer to: XML Comments Guide Page 20.

Note that the code you reference will be displayed directly in place rather than a link. It is not perfect, but I hope it helps.



来源:https://stackoverflow.com/questions/12770486/a-way-to-link-to-a-class-a-method-especially-a-specific-code-line-in-c-sharp-co

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!