9
ответов
Существующий Стандартный стиль и Кодирование стандартных [закрытых] документов
Следующее было предложено для предстоящего проекта C++. Стандарты Кодирования C++, Воздушным Механизмом Sutter и Alexandrescu JSF стандарты кодирования C++ Элементы Стиля C++ Эффективный C++ 3-й Выпуск...
вопрос задан: 23 May 2017 12:01
9
ответов
Язык Python [закрытый] API
Я запускаю с Python, прибывающего из Java. Я задавался вопросом, существует ли там что-то подобное JavaDoc API, где я могу найти класс, его методы и и пример того, как использовать его. Я нашел очень...
вопрос задан: 11 June 2015 06:27
9
ответов
Doxygen, слишком тяжелый для поддержания? [закрытый]
Я в настоящее время начинаю использовать doxygen для документирования моего исходного кода. У меня есть уведомление, что синтаксис очень тяжел, каждый раз, когда я изменяю исходный код, я также должен изменить комментарий, и я действительно имею...
вопрос задан: 9 March 2010 09:43
9
ответов
Java Профессионалы/Недостатки JAXB и [закрытая] Документация
Это было некоторое время, так как я использовал Java в гневе, поэтому простите мне, если это глупо. Я имею, просто начал на проекте Java, где мы используем JAXB для десериализации поступления строка XML (от...
вопрос задан: 24 December 2008 16:30
9
ответов
Приложение (Не язык разметки) для создания [закрытого] руководства пользователя
Кто-либо может рекомендовать программе создать руководства пользователя с? Не язык разметки (как ЛАТЕКС или DocBook), но больше что-то интерактивное как Scribus. Поскольку я не единственный, который обновит...
вопрос задан: 17 December 2008 06:57
8
ответов
Ища стиль Wiki, автономное, управление версиями - “безопасный” [закрытый] пакет документации
Моя команда и я нашли, что документирование нашего проекта (платформа разработки w/API) с Wiki и полезно для нас и полезно для пользователей. Из-за некоторых организационных вопросов, мы вынуждены сделать...
вопрос задан: 23 September 2017 06:23
8
ответов
Почему Писк использует Цвета для идентификации Кнопок мыши? [закрытый]
Это является действительно раздражающим, когда Вы пытаетесь следовать за Писком документации Примером. Вместо того, чтобы назвать кнопки мыши оставленными, право, и середина, как в любой другой документации, они дают им...
вопрос задан: 8 January 2015 20:36
8
ответов
Действительно ли необходимо генерировать javadoc как часть процесса сборки? [закрытый]
Действительно ли необходимо генерировать javadoc как часть процесса сборки?
вопрос задан: 14 May 2014 19:51
8
ответов
Потрясающий Код C# для изучения шаблонов разработки и лучших практик от? [закрытый]
Кто-либо знает какой-либо открытый исходный код c#/asp.net проекты, которые хорошо документируются, используют шаблоны разработки соответственно и содержат лучшие практики? Я хочу прочитать высококачественный код, извлечь уроки из него и применить его...
вопрос задан: 24 April 2013 15:07
8
ответов
Инструмент, чтобы добавить и завершить [закрытую] документацию исходного кода PHP
У меня есть несколько законченных, более старых проектов PHP с большим количеством из, включает это, я хотел бы зарегистрировать в стиле javadoc/phpDocumentor. Работая через каждый файл вручную и будучи вынужденным сделать...
вопрос задан: 14 January 2011 23:57
8
ответов
Документирование кода при оставлении компании [закрытой]
Я ушел из своего текущего места работы вчера, и я беру его на меня для документирования моих проектов, таким образом, я могу передать их легко. Мысль, что мой код уже прокомментирован к пользе...
вопрос задан: 26 July 2010 03:17
8
ответов
Как зарегистрировать вызванные исключительные ситуации в [закрытом] c#/.net
Я в настоящее время пишу маленькую платформу, которая будет использоваться внутренне другими разработчиками в компании. Я хочу предоставить хорошую информацию о Intellisense, но я не уверен, как зарегистрировать брошенный...
вопрос задан: 2 June 2010 10:29
8
ответов
Способы синхронизировать интерфейс и реализацию комментируют в [закрытом] C#
Там автоматические пути состоят в том, чтобы синхронизировать комментарии между интерфейсом и его реализацией? Я в настоящее время документирую их обоих и не хотел бы вручную сохранять их в синхронизации. ОБНОВЛЕНИЕ: Рассмотрите этот code:...
вопрос задан: 5 May 2009 09:37
7
ответов
Автоматическая генерация документации PHP? [закрыто]
Для ActionScript 2 я использовал NaturalDocs. Однако у него довольно слабая поддержка PHP. Я до сих пор смотрел на doxygen и phpDocumentor, но их вывод довольно уродлив, на мой взгляд. У кого-нибудь есть ...
вопрос задан: 12 December 2018 12:37
7
ответов
Как к лучшей версии разрабатывают документы? [закрытый]
Было некоторое обсуждение ТАК (здесь и здесь) прежде о том, как офисные документы могут быть имеющими версию, однако я думаю, что мой вопрос все еще немного отличается. Мои проекты программирования запускаются с...
вопрос задан: 23 May 2017 12:19
7
ответов
Что должно, люди, плохо знакомые с Python, знают о его сообществе и экосистеме? [закрытый]
Я чиню своего рода введение в Python, но тот, который фокусируется на сообществе и экосистеме вокруг Python, а не просто языка. С тем, Как Думать Как Компьютер...
вопрос задан: 23 May 2017 12:14
7
ответов
Как зарегистрировать [закрытую] базу данных
(Примечание: Я понимаю, что это близко к тому, Как Вы документируете свою структуру базы данных?, но я не думаю, что это идентично.) я запустил работу над местом с базой данных с буквально сотнями таблиц и...
вопрос задан: 23 May 2017 12:02
7
ответов
Как Вы удостоверяетесь, что код снова используется правильно? [закрытый]
Часто, когда мы вводим новую возможность в приложение, мы можем произвести артефакты, такие как полезные методы или классы, которые могли быть снова использованы в других областях наших приложений. Эти артефакты...
вопрос задан: 23 May 2017 10:27
7
ответов
Как вы читаете JavaDoc? [закрыто]
Какие инструменты / сайты вы используете для чтения JavaDocs? В настоящее время я использую Firefox с 20+ открытыми вкладками при работе над проектом J2EE, чтобы иметь всю доступную документацию, которая не очень удобна, кушает ...
вопрос задан: 11 December 2015 09:42
7
ответов
Действительно ли 100%-е покрытие кода является действительно хорошей вещью при выполнении модульных тестов? [закрытый]
Я всегда узнавал, что выполнение максимального покрытия кода с модульными тестами хорошо. Я также слышу разработчиков от крупных компаний, таких как Microsoft, говоря, что они пишут больше строк тестирования кода, чем...
вопрос задан: 4 May 2015 04:32
7
ответов
Передача моего собственного проекта на ком-то еще - что сделать? [закрытый]
Часто существуют ситуации, куда проект передается кому-то еще. И часто этот процесс неприятен для обеих сторон - новый владелец жалуется на ужасную документацию, ошибки и плохой дизайн...
вопрос задан: 31 July 2010 11:49
7
ответов
Насколько хороший Подверсия при хранении большого количества двоичных файлов? [закрытый]
Я ищу место для помещения некоторых ГБ документов (главным образом .doc и .xls). Моей команде уже настроили сервер Подверсии для управления документами, которые мы создаем, таким образом, я предпочел бы использовать это, если это возможно....
вопрос задан: 21 February 2009 05:00
7
ответов
Что лучший способ состоит в том, чтобы зарегистрировать код Perl? [закрытый]
Какое-либо предложение, как я могу зарегистрировать свой код Perl? Что Вы используете и какие инструменты доступны для помощи мне? Какой модуль Вы используете для преобразования переходной приставки в HTML?
вопрос задан: 10 October 2008 15:50
6
ответов
Пакетная документация по сценариям [закрывается]
Есть ли некоторая хорошая документация для пакета Windows сценарии, я могу загрузить и обратиться к в то время как офлайн?
вопрос задан: 18 January 2018 01:13
6
ответов
Какие документы должны храниться в управлении версиями и как они должны быть сохранены? [закрытый]
Я нашел некоторые подобные вопросы (здесь, здесь, и здесь) спрашивающий о том, чтобы хранить документы в управление версиями. У меня есть более конкретное требование и общий вопрос. Конкретное требование - это...
вопрос задан: 23 May 2017 12:34
6
ответов
.Net XML comment в документацию API
Существует ли простой способ произвести документацию стиля MSDN из Visual Studio вывод XML? Я не достаточно терпелив для установки хорошего xslt для него, потому что я знаю, что я не первый человек, который пересечет это...
вопрос задан: 25 June 2014 19:54
6
ответов
Техническое описание: Как записать [закрытый] тот
Люди, Что лучший способ состоит в том, чтобы пойти об исследовании и представлении для технического технического описания? Я не имею в виду формат, обзор, разделы и такой материал. Я никогда не писал один - и интересно если...
вопрос задан: 9 December 2011 19:29
6
ответов
Альтернативные способы просмотреть [закрытый] API питона
Это - просто я, или документацию библиотеки стандарта питона чрезвычайно трудно просмотреть? http://docs.python.org/3.1/library/index.html http://docs.python.org/3.1/modindex.html Ява имеет...
вопрос задан: 25 January 2010 09:57
6
ответов
Что такое хорошее решение для сбора документации бизнес-правила? [закрытый]
Я сталкиваюсь с ситуацией, распространенной, я уверен, где моя документация бизнес-правила распространена через электронные письма, документацию (теперь устаревший) и IMS. Это воняет. Я могу думать о 2 альтернативах:...
вопрос задан: 16 September 2009 14:29
6
ответов
документация для STL [закрыто]
Я провел последние несколько лет, борясь изо всех сил, чтобы избежать работы с C ++, поэтому я, вероятно, один из очень небольшого числа людей, которые любят системное программирование и шаблонное метапрограммирование ...
вопрос задан: 27 August 2009 23:41