Вопросы с тегом «documentation-generation»

Разработка, основанная на поведении, с ее символическим синтаксисом сценариев «задано, когда», в последнее время получила широкое распространение из-за его возможного использования в качестве граничного объекта для оценки функциональности программного обеспечения. Я , безусловно , согласен , что Огурец , или какой бы ни функция определения сценария вы предпочитаете, является бизнес …

24 documentation  bdd  documentation-generation  business-rules 

Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто в прошлом году . Я хочу документировать свой код так, чтобы минимальная потребность в чтении и …

22 documentation  code-reviews  documentation-generation  help-documentation 

Итак, у нас есть такой интерфейс /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Недавно мы воспроизвели документацию, в которой рассказывалось …

20 c#  documentation  xml  documentation-generation 

В настоящее время я использую две системы для написания документации кода (я использую C ++): Документация о методах и членах класса добавляется рядом с кодом в формате Doxygen. На сервере Doxygen запускается на источниках, поэтому вывод можно увидеть в веб-браузере Страницы обзора (описывающие набор классов, структуру приложения, пример кода, ...) …

13 documentation  documentation-generation  wiki 

Есть ли хороший термин, который похож, но отличается от «не рекомендуется», чтобы означать, что метод или API находятся в базе кода, но не должны использоваться, потому что их реализация не завершена или, вероятно, изменится? (Да, я знаю, эти методы не должны быть общедоступными, яда, яда, яда. Я не создавал свою …

12 documentation  terminology  api  documentation-generation  javadocs 

Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 4 года назад . Я закончил веб-приложение, которое в основном разработано на PHP и является …

11 project-management  documentation  documentation-generation  projects-and-solutions 

Я задокументировал свой код для doxygen, но я не хочу использовать HTML по умолчанию. Я знаю, что могу настроить его, предоставляя собственные CSS, верхние и нижние колонтитулы и т. Д. (Как это делает GNOME), и как я могу добавить общий PHP-код в файлы и сказать, чтобы он сохранялся как .php, …

10 documentation  templates  documentation-generation