Запитання з тегом «documentation-generation»

Розвиток, керований поведінкою, з його емблематичним синтаксисом сценаріїв "Дано-Коли-Потім" останнім часом є досить розкритим щодо можливого його використання як граничного об'єкта для оцінки функціональності програмного забезпечення. Я, безумовно, погоджуюся, що Gherkin або будь-який сценарій визначення функцій, який ви надаєте перевагу, - це бізнес- читабельний DSL , який вже читається , …

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