14
ответов

Документация кода: Сколько слишком много?

Сколько документация кода в Вашем источнике.NET слишком много? Некоторый фон: Я наследовал большую кодовую базу, что я говорил о в некоторых из других вопросов, на которых я отправил здесь ТАК. Один из "...
вопрос задан: 13 November 2008 21:36
8
ответов

Что такое Лучшие практики Для Документирования кода C# с XML-комментариями?

Я прохожу некоторый новый код, который я просто написал и добавляющий NDoc sytle комментарии к моим классам и методы. Я надеюсь генерировать довольно хороший документ стиля MSDN для ссылки. В целом, что...
вопрос задан: 29 June 2010 17:46
6
ответов

Наиболее распространенный docblock для Delphi и/или кода FreePascal

Я довольно знаком с PHP dockblocks, так как это было мое задание для последних 15 + годы. / ** * Описание * * @tag bla bla * @tag больше bla bla */, Что я пытаюсь понять, - то, если существует...
вопрос задан: 29 March 2010 15:22
4
ответа

codestyle; помещенный javadoc прежде или после аннотации?

Я знаю, что это не является самым жизненно важным из проблем, но я просто понял, что могу поместить блок комментария Javadoc прежде или после аннотации. Что мы хотели бы принять как стандарт кодирования? / ** *...
вопрос задан: 5 December 2013 20:20
2
ответа

Как проверить объект CheckListBox с одиночным нажатием?

Я кодирую приложение Windows Forms в C# и использую Управление CheckListBox. Как проверить объект CheckListBox только с одиночным нажатием?
вопрос задан: 1 October 2009 11:13
1
ответ

Выборочно подавите Комментарии кода XML в C#?

Мы поставляем много блоков внешним клиентам, но не все общедоступные API официально поддерживаются. Например, из-за меньше, чем оптимальных проектных решений иногда тип должен быть...
вопрос задан: 19 March 2010 01:05
1
ответ

Как я могу вынудить Doxygen показать полный, включают путь?

Как я могу вынудить Doxygen показать полный, включают путь? Что делает я имею в виду: у Меня есть нечто класса:: панель:: пчела определила в bee.hpp в следующей структуре каталогов: нечто/панель нечто foo/bar/bee.hpp Doxygen, когда это...
вопрос задан: 11 March 2010 10:36
0
ответов

Как создать комментарий к представлению базы данных oracle

Мне бы очень хотелось создать комментарий к представлению с кратким описанием его назначения. К сожалению, в оракуле нельзя создавать комментарии к представлениям. Эта функция только для таблиц,...
вопрос задан: 21 February 2018 20:38
0
ответов

Оптимальная структура базы данных - «шире» таблица с пустыми полями или большим количеством таблиц?

Мне нужно разместить дополнительные данные в базе данных, и у меня есть выбор между изменением существующей таблицы (table_existing) или созданием новых таблиц. Вот как сейчас выглядит table_existing: ...
вопрос задан: 23 May 2017 11:53
0
ответов

Отключить автоматическое создание заголовка файла (ReSharper и StyleCop)

Недавно я установил версию R #6.1 (C #, не полную )с StyleCop 4.7.34.0 (с плагином R #). При добавлении нового класса в проект автоматически добавляется информация о заголовке файла. Как вы...
вопрос задан: 23 May 2017 02:08
0
ответов

Сводный комментарий Visual Studio XML на одной строке

Как в Visual Studio изменить фрагмент сводного комментария XML по умолчанию с трех строк на одну строку? В настоящее время он предоставляет этот фрагмент, когда я набираю ///: /// /// ///
вопрос задан: 15 April 2016 14:46
0
ответов

Действительно ли возможно объединить две страницы, созданные SandCastle в единственную основную страницу?

Для каждого класса в проекте SandCastle создает (среди других) две страницы: основная страница, названная как T_class_full_name, с описанием, Синтаксисом, Иерархией наследования и, Видит Также участников...
вопрос задан: 28 January 2013 09:53
0
ответов

Как документировать возврат в JavaScript

Я пишу свою собственную библиотеку для проекта на работе для приложения браузера, и у меня есть та же старая проблема, решая, как комментировать код. Я пытаюсь следовать синтаксису JsDoc, но буду...
вопрос задан: 20 June 2012 10:10
0
ответов

Установка PHPDocumentor вручную на Mac

После безуспешной попытки установить PHPDocumentor с PEAR, я попробовал это вручную, как подробно описано на официальном сайте:http://www.phpdoc.org/docs/latest/for-users/installation.htmlЯ...
вопрос задан: 26 April 2012 18:02
0
ответов

Как писать комментарии к документации на ANSI C? [closed]

Я не могу найти, как писать комментарии на C. Я имею в виду, что знаю о // и / * * /, я имею в виду, где я могу найти передовой опыт? Например, если у меня есть функция, как мне написать, что переменная @param - это значение ...
вопрос задан: 28 January 2012 08:30
0
ответов

ReSharper - как отключить создание заголовков мусорной документации в коде Очистка

Мы используем ReSharper 6.0 со StyleCop для ReSharper. Хотя мы используем правило StyleCop, согласно которому члены должны иметь заголовки документации, мы не хотим, чтобы средство очистки кода ReSharper генерировало ...
вопрос задан: 17 November 2011 10:19
0
ответов

Как лучше всего обрабатывать / форматировать документацию Javadoc и аннотации в коде? [дубликат]

Я просмотрел этот форум, погуглил и не знаю, как лучше всего обрабатывать документацию Javadoc и аннотации, которые появляются вместе в одном классе. Судя по тому, что я вижу от Sun / ...
вопрос задан: 8 August 2011 14:11
0
ответов

Документирование проектов Node.js [закрыто]

В настоящее время я использую JSDoc Toolkit для документирования своего кода, но он не совсем подходит, а именно, похоже, с описанием пространств имен возникают проблемы должным образом. Допустим, у вас есть два простых класса в каждом файле: ...
вопрос задан: 23 May 2011 11:39