Способ ссылки на класс, метод, особенно на определенную строку кода в комментарии C#
Я хочу создать вид документации, используя ссылки в коде, которые указывают на цель. Целью может быть Class
или Method
или конкретная строка кода. (указание на определенную строку кода является наиболее важным)
я подумал о расширении для VS2010 или конкретного тега комментариев.
есть ли способ сделать ссылки такого рода ?
1 ответов
XML-комментарий + sandcastle может быть то, что вам нужно. Вы можете ссылаться на указанный класс или метод, используя
<see cref=".."/>
и ссылочные параметры с помощью
<paramref name=".."/>
однако, нет прямого метода для ссылки на определенные строки кода, но вы можете ссылаться на определенную # область, используя
<code source="$sourcefile$" region="$regionname$"/>
пожалуйста, обратитесь к: XML Комментарии руководство Страница 20.
обратите внимание, что кода будет отображаться непосредственно на месте, а не соединение. Это не идеально, но я надеюсь, что это поможет.