Code Documentation

[dakata__92]

Колеги, какво ползвате за автоматично създаване на хубава и проста документация на вашето приложение? Търся някакво просто и лесно приложение, което да създава документация.

 

[Revelation]

Ако ще документираш API, използвай Swagger/OpenAPI.

 

[dakata__92]

Ако ще документираш API, използвай Swagger/OpenAPI.

По-скоро търся по-масови решения. Смисъл нещо леко и базисно.

 

[Revelation]

Нали се сещаш, че има 100 вида документации. Дефинирай какво искаш по-точно да документираш и какво значи "по-масово" решение.

Също много зависи каква ти е базата на кода, според кода ли искаш нещо да се документира и т.н.

 

[dakata__92]

Нали се сещаш, че има 100 вида документации. Дефинирай какво искаш по-точно да документираш и какво значи "по-масово" решение.

Също много зависи каква ти е базата на кода, според кода ли искаш нещо да се документира и т.н.

Честно казано и аз не знам. Примерно ми се иска нещо, което да генерира документация по коментарите в кода. Нещо семпло и бързо генериращо.

 

[Revelation]

Ако използваш phpDoc използвай вградения екстрактор.

https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using

Задаваш му директорията, в която да чете и къде да ги екстрактне и ти ги вади в HTML формат с интерфейс.