Будет ли MS Visual Studio 2008 отображать справку по моим собственным функциям, если я буду использовать для них комментарии в стиле Javadoc?

StackOverflow https://stackoverflow.com/questions/218859

Вопрос

Например, в C # или в документах JavaScript.
Если нет, есть ли смысл использовать комментарии Javadoc в программировании ASP.NET?

Это было полезно?

Решение

Я почти уверен, что ответом будет «нет». Почему вы используете комментарии в стиле Javadoc, а не комментарии XML? Комментарии XML будут автоматически отображаться механизмом Intellisense, а также позволят вам создавать внешние документы с помощью таких инструментов, как SandCastle.

Другие советы

Скотт прав, вы должны использовать нативные комментарии XML, чтобы получить искомый смысл. Что касается Javascript intellisense, я думаю, что вам нужно создать специальный файл .js (вручную или динамически) с комментариями xml для этого, а затем ссылаться на него в своих файлах .js. Большинство библиотек .js содержат эти специальные файлы с комментариями .js, на которые вы можете ссылаться для примера.

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top