Code Documentation

C++ JAVA
Post Reply
User avatar
dakata__92
Web-tourist
Web-tourist
Posts: 3302
Joined: Tue Aug 02, 2011 7:24 pm
Answers: 126

Code Documentation

Post by dakata__92 » Mon Apr 20, 2020 8:09 am

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

User avatar
Revelation
Web-tourist
Web-tourist
Posts: 891
Joined: Sun Mar 24, 2013 1:23 pm
Answers: 63

Re: Code Documentation

Post by Revelation » Mon Apr 20, 2020 2:06 pm

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

User avatar
dakata__92
Web-tourist
Web-tourist
Posts: 3302
Joined: Tue Aug 02, 2011 7:24 pm
Answers: 126

Re: Code Documentation

Post by dakata__92 » Mon Apr 20, 2020 2:33 pm

Revelation wrote:
Mon Apr 20, 2020 2:06 pm
Ако ще документираш API, използвай Swagger/OpenAPI.
По-скоро търся по-масови решения. Смисъл нещо леко и базисно.

User avatar
Revelation
Web-tourist
Web-tourist
Posts: 891
Joined: Sun Mar 24, 2013 1:23 pm
Answers: 63

Re: Code Documentation

Post by Revelation » Mon Apr 20, 2020 3:46 pm

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

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

User avatar
dakata__92
Web-tourist
Web-tourist
Posts: 3302
Joined: Tue Aug 02, 2011 7:24 pm
Answers: 126

Re: Code Documentation

Post by dakata__92 » Mon Apr 20, 2020 4:07 pm

Revelation wrote:
Mon Apr 20, 2020 3:46 pm
Нали се сещаш, че има 100 вида документации. Дефинирай какво искаш по-точно да документираш и какво значи "по-масово" решение.

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

User avatar
Revelation
Web-tourist
Web-tourist
Posts: 891
Joined: Sun Mar 24, 2013 1:23 pm
Answers: 63

Re: Code Documentation

Post by Revelation » Mon Apr 20, 2020 9:17 pm

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

https://manual.phpdoc.org/HTMLSmartyCon ... html#using

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

Post Reply