Форум программистов, компьютерный форум, киберфорум
C# для начинающих
Войти
Регистрация
Восстановить пароль
 
667 / 213 / 88
Регистрация: 21.07.2016
Сообщений: 1,036
Записей в блоге: 2
1

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

05.12.2017, 10:25. Показов 446. Ответов 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
Programming
Эксперт
94731 / 64177 / 26122
Регистрация: 12.04.2006
Сообщений: 116,782
05.12.2017, 10:25
Ответы с готовыми решениями:

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

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

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

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

6
Эксперт .NET
8868 / 6178 / 1031
Регистрация: 21.01.2016
Сообщений: 23,357
05.12.2017, 10:26 2
dailydose, просто трижды нажмите "/" перед именем метода.
1
667 / 213 / 88
Регистрация: 21.07.2016
Сообщений: 1,036
Записей в блоге: 2
05.12.2017, 10:55  [ТС] 3
Цитата Сообщение от Usaga Посмотреть сообщение
просто трижды нажмите "/" перед именем метода.
подставляется пустой комментарий
/// <summary>
///
/// </summary>
т.е. автоматически не анализируются ни параметры, ни возвращаемое значение и прр
0
Эксперт .NET
8868 / 6178 / 1031
Регистрация: 21.01.2016
Сообщений: 23,357
05.12.2017, 11:00 4
dailydose, у меня работает корректно...
0
управление сложностью
1664 / 1279 / 256
Регистрация: 22.03.2015
Сообщений: 7,508
Записей в блоге: 5
05.12.2017, 13:16 5
dailydose, тоже сейчас проверил - работает корректно, если имеются параметры
0
667 / 213 / 88
Регистрация: 21.07.2016
Сообщений: 1,036
Записей в блоге: 2
05.12.2017, 15:22  [ТС] 6
ну собственно есть такой код
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
8868 / 6178 / 1031
Регистрация: 21.01.2016
Сообщений: 23,357
05.12.2017, 16:46 7
dailydose, ну, всё корректно.
1
IT_Exp
Эксперт
87844 / 49110 / 22898
Регистрация: 17.06.2006
Сообщений: 92,604
05.12.2017, 16:46

Заказываю контрольные, курсовые, дипломные работы и диссертации здесь.

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

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

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

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


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

Или воспользуйтесь поиском по форуму:
7
Ответ Создать тему
Опции темы

КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin® Version 3.8.9
Copyright ©2000 - 2021, vBulletin Solutions, Inc.