Форум программистов, компьютерный форум, киберфорум
C# для начинающих
Войти
Регистрация
Восстановить пароль
Блоги Сообщество Поиск Заказать работу  
 
Рейтинг 4.83/6: Рейтинг темы: голосов - 6, средняя оценка - 4.83
 Аватар для dailydose
671 / 217 / 88
Регистрация: 21.07.2016
Сообщений: 1,036
Записей в блоге: 2

Генератор комментариев для документации

05.12.2017, 10:25. Показов 1348. Ответов 6
Метки нет (Все метки)

Студворк — интернет-сервис помощи студентам
Есть какие-либо плагины для MSVS2015 для создания подобных комментариев?
C#
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
        /// <summary>
        /// Divides the two numbers specified and returns the result.
        /// </summary>
        /// <param name="number1">
        /// A <see cref="System.Int32"/>
        /// </param>
        /// <param name="number2">
        /// A <see cref="System.Int32"/>
        /// </param>
        /// <throws>
        /// A <see cref="DivideByZeroException"/>
        /// </throws>
        /// <returns>
        /// A <see cref="System.Int32"/>
        /// </returns>
        public int Divide(int number1, int number2)
        {
            return result = number1 / number2;
        }
Например в том же PhpStorm есть PhpDoc который сам генерирует подобные комментарии после написания /** и нажатия ENTER
0
IT_Exp
Эксперт
34794 / 4073 / 2104
Регистрация: 17.06.2006
Сообщений: 32,602
Блог
05.12.2017, 10:25
Ответы с готовыми решениями:

Инструменты для создания документации .net
Подскажите пожалуйста БЕСПЛАТНЫЕ инструменты для создания документации к программе, написанной на Visual Studio 2013. Полученная...

Что надо для создания документации в Doxygen?
Что надо для создания документации в Doxygen? Предположим, что есть код и комментарии к нему. Какая дальнейшая последовательность действий....

Генератор документации
Помогите написать генератор документации, не могу разобраться с функциями

6
Эксперт .NET
 Аватар для Usaga
14307 / 9388 / 1355
Регистрация: 21.01.2016
Сообщений: 35,405
05.12.2017, 10:26
dailydose, просто трижды нажмите "/" перед именем метода.
1
 Аватар для dailydose
671 / 217 / 88
Регистрация: 21.07.2016
Сообщений: 1,036
Записей в блоге: 2
05.12.2017, 10:55  [ТС]
Цитата Сообщение от Usaga Посмотреть сообщение
просто трижды нажмите "/" перед именем метода.
подставляется пустой комментарий
/// <summary>
///
/// </summary>
т.е. автоматически не анализируются ни параметры, ни возвращаемое значение и прр
0
Эксперт .NET
 Аватар для Usaga
14307 / 9388 / 1355
Регистрация: 21.01.2016
Сообщений: 35,405
05.12.2017, 11:00
dailydose, у меня работает корректно...
0
управление сложностью
 Аватар для Почтальон
1693 / 1306 / 259
Регистрация: 22.03.2015
Сообщений: 7,545
Записей в блоге: 5
05.12.2017, 13:16
dailydose, тоже сейчас проверил - работает корректно, если имеются параметры
0
 Аватар для dailydose
671 / 217 / 88
Регистрация: 21.07.2016
Сообщений: 1,036
Записей в блоге: 2
05.12.2017, 15:22  [ТС]
ну собственно есть такой код
C#
1
2
3
4
5
6
7
8
9
        private Type FindProgram(string programName)
        {
            var targetName = ParseProgramName(programName);
            if (targetName == null)
                return null;
 
            var programType = Type.GetType(GetType().Namespace + "." + targetName + "." + EntryPointClassname);
            return programType;
        }
и вот такой комментарий получаю на выходе
/// <summary>
///
/// </summary>
/// <param name="programName"></param>
/// <returns></returns>
0
Эксперт .NET
 Аватар для Usaga
14307 / 9388 / 1355
Регистрация: 21.01.2016
Сообщений: 35,405
05.12.2017, 16:46
dailydose, ну, всё корректно.
1
Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
BasicMan
Эксперт
29316 / 5623 / 2384
Регистрация: 17.02.2009
Сообщений: 30,364
Блог
05.12.2017, 16:46
Помогаю со студенческими работами здесь

Создание документации для пользователя
Собственно, постал вопрос реализации данного элемента, как его лучше сделать?

Вывод рекламы в списке комментариев (через каждый 10 комментариев) в WordPress
Привет! Подскажите как сделать вывод рекламы (adsense) в списке комментариев (через каждый 10 комментариев) в WordPress? Не нашел в поиске...

Код, используемый для создания документации
Первая лаба по Java и уже проблема(надеюсь, что правильную категорию выбрал для этого вопроса). Смотрю на это задание как баран :wall: и...

Программное изменение документации для методов
Здраствуйте, нуждаюсь в помощи. Например такой код class A: &quot;&quot;&quot; Class docstring &quot;&quot;&quot; ...

Какой софт использовать для документации проекта
Подскажите пожалуйста, пишу оконное приложение, с использованием СУБД Firebird, которое нужно задокументировать. Пробовал doxygen, но он...


Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
7
Ответ Создать тему
Новые блоги и статьи
Оттенки серого
Argus19 18.03.2026
Оттенки серого Нашёл в интернете 3 прекрасных модуля: Модуль класса открытия диалога открытия/ сохранения файла на Win32 API; Модуль класса быстрого перекодирования цветного изображения в оттенки. . .
SDL3 для Desktop (MinGW): Рисуем цветные прямоугольники с помощью рисовальщика SDL3 на Си и C++
8Observer8 17.03.2026
Содержание блога Финальные проекты на Си и на C++: finish-rectangles-sdl3-c. zip finish-rectangles-sdl3-cpp. zip
Символические и жёсткие ссылки в Linux.
algri14 15.03.2026
Существует два типа ссылок — символические и жёсткие. Ссылка в Linux — это запись в каталоге, которая может указывать либо на inode «файла-ИСТОЧНИКА», тогда это будет «жёсткая ссылка» (hard link),. . .
[Owen Logic] Поддержание уровня воды в резервуаре количеством включённых насосов: моделирование и выбор регулятора
ФедосеевПавел 14.03.2026
Поддержание уровня воды в резервуаре количеством включённых насосов: моделирование и выбор регулятора ВВЕДЕНИЕ Выполняя задание на управление насосной группой заполнения резервуара,. . .
делаю науч статью по влиянию грибов на сукцессию
anaschu 13.03.2026
прикрепляю статью
SDL3 для Desktop (MinGW): Создаём пустое окно с нуля для 2D-графики на SDL3, Си и C++
8Observer8 10.03.2026
Содержание блога Финальные проекты на Си и на C++: hello-sdl3-c. zip hello-sdl3-cpp. zip Результат:
Установка CMake и MinGW 13.1 для сборки С и C++ приложений из консоли и из Qt Creator в EXE
8Observer8 10.03.2026
Содержание блога MinGW - это коллекция инструментов для сборки приложений в EXE. CMake - это система сборки приложений. Здесь описаны базовые шаги для старта программирования с помощью CMake и. . .
Как дизайн сайта влияет на конверсию: 7 решений, которые реально повышают заявки
Neotwalker 08.03.2026
Многие до сих пор воспринимают дизайн сайта как “красивую оболочку”. На практике всё иначе: дизайн напрямую влияет на то, оставит человек заявку или уйдёт через несколько секунд. Даже если у вас. . .
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin
Copyright ©2000 - 2026, CyberForum.ru