Вопросы с тегом 'documentation'

ЭТОТ ТОГ ТОЛЬКО ДЛЯ ГЕНЕРАТОРОВ ДОКУМЕНТА. Включите язык и/или тег SDE. НЕ ИСПОЛЬЗУЙТЕ, чтобы запрашивать ссылки на документацию или инструменты или критиковать документацию поставщика.
22

Способ создания многострочных комментариев в Python?

Недавно я начал изучать Python, но не смог найти, как реализовать многострочные комментарии. Большинство языков имеют символы комментариев блока, такие как /* */ Я попробовал это в Python, но он выдает ошибку, поэтому это, вероятно, неверно. Ест...
08 окт. '11 в 12:51
8

Каков стандартный формат docstring Python?

Я видел несколько разных стилей написания docstrings в Python, есть ли официальный или "согласованный" стиль?
10 окт. '10 в 1:10
8

Какая разница между модульными, функциональными, приемными и интеграционными тестами?

В чем разница между тестированием на единицу, функционала, приемки и интеграции (и любые другие типы тестов, о которых я не упоминал)?
04 февр. '11 в 23:59
11

Просмотр информации о методе в Android Studio

В Eclipse, когда вы наводите указатель мыши на метод, появится окно с описанием того, что делает этот метод, что означают параметры и что он возвращает. Есть ли способ заставить Android Studio сделать то же самое?
18 мая '13 в 0:49
4

Есть ли у JavaScript стандарт для комментариев?

В настоящее время я пишу код JavaScript на стороне клиента и задаюсь вопросом, как комментировать мои функции. Я исхожу из фона С#, где есть официально рекомендованный стиль комментариев документированный Microsoft, который я следую, что позволяет к...
12 апр. '12 в 15:03
8

Как написать хороший README

Я думаю, что все видели файл README, но я бы хотел, чтобы окончательное руководство о том, как написать отличный файл README с наименьшим количеством энергии, потраченной на него. Что такое README файл? Что я должен писать в нем? Как именно отф...
21 февр. '10 в 5:14
20

Лучшие советы по документированию кода с использованием doxygen?

Моя команда начинает документировать наш C-код, используя doxygen, обращая особое внимание на наши публичные заголовки API. Кажется, в doxygen много гибкости и разных специальных команд, что здорово, но неясно, какая хорошая вещь и что плохое без про...
09 сент. '08 в 11:41
49

Что такое самодокументирующий код и может ли он заменить хорошо документированный код?

У меня есть коллега, который настаивает на том, что его код не нуждается в комментариях, он "сам документирует". Я просмотрел его код, и, хотя он более ясный, чем код, который я видел в других продуктах, я по-прежнему не согласен с тем, что самодоку...
16 окт. '08 в 15:24
6

Как написать документ технической спецификации для моего программного проекта?

Я видел здесь несколько вопросов, говорящих, что нет необходимости писать многообещающую техническую спецификацию, если функциональная спецификация обладает всеми функциональными возможностями. Что касается ситуаций, когда клиент предоставил функцион...
24 мар. '09 в 15:25
12

Есть ли у Swift документы или инструменты для документации?

Многие языки поддерживают комментарии к документации, чтобы позволить генератору (например, javadoc или doxygen) генерировать документацию кода путем анализа тот же код. Есть ли у Swift какие-либо комментарии к документации по документации или ин...
04 июн. '14 в 21:34
16

Хорошее введение в .NET Reactive Framework

Помимо документации Microsoft, есть ли хорошее введение и учебник в среду Microsoft Reactive (Rx)? Кроме того, что является хорошим примером (с кодом), что Reactive упрощает задачу программирования, которую сложно решить с использованием обычных мет...
20 окт. '09 в 17:33
21

Какой лучший способ редактировать GitHub Readme.md?

Какой лучший способ редактировать GitHub Readme.md? Я нахожу, что редактирую Readme, затем нажимаю его, вижу ошибки или ошибки форматирования, снова редактирую его, а затем нажимаю на него... Это действительно число в истории фиксации. Есть ли луч...
03 июн. '12 в 16:09
4

Какие новые команды документации доступны в Xcode 5?

Одной из новых функций Xcode 5 является возможность документировать свой собственный код со специальным синтаксисом комментариев. Формат похож на doxygen, но, похоже, поддерживает только подмножество этих функций. Какие команды поддерживаются, а ка...
03 окт. '13 в 20:14
8

Технические советы для написания замечательного Javadoc

Каковы ваши технические советы для написания отличного Javadoc? Я ищу вещи, выходящие за рамки стандартных советов по теме "Объяснение функции". Мы все это знаем! (Правильно?) Мне интересны такие вещи: Какие теги должны определенно быть частью...
29 дек. '09 в 20:16
15

Создание большой документации API: инструменты и методы

Мне поручено создать веб-сервис, который будет использоваться несколькими разными разработчиками, использующими разные платформы, работающие для разных компаний и имеющие значительно разные уровни квалификации. Таким образом, я хотел бы создать докум...
04 янв. '10 в 20:11