Я следовал этому руководству MSDN для комментирования моего кода.
Я обнаружил, что могу использовать внешних файлов для достижения того же результата в более чистом виде.
Однако мой IntelliSense не отображает эти комментарии в Visual Studio (в этом случае файл хранится в корне приложения, того же уровня, что и файл .sln). экран здесь
Я выполнил следующие действия, чтобы убедиться, что это не ошибочный проект:
- Я создал новую библиотеку классов .NET
- Iсоздал новый файл проекта с именем docs.xml (как руководство)
Я поместил этот код в этот новый файл:
<docs>
<members name="class1">
<Class1>
<summary> This is a test description </summary>
</Class1>
</members>
</docs>
Я включил «XML-файл документации» в настройках проекта и оставил значение по умолчанию (bin\ClassLibrary1.xml)
- Я вставил xml над объявлением класса:
/// <include file='docs.xml' path='docs/members[@name="class1"]/Class1/*'
public class Class1 { }
- Построение решения
- Однако сводка не указана.
В скомпилированном файле bin xml представлена сводка, указанная в этом файлеи использование таких инструментов, как SandCastle, показывает документацию правильно.
Я делаю что-то не так или это поведение по умолчанию?Я искал в сети (особенно здесь) и не нашел правильного решения проблемы.