Autor | Zpráva | ||
---|---|---|---|
ananasovapasta Profil * |
#1 · Zasláno: 21. 12. 2009, 19:20:13
jak má vypadat php dokumentace, jedná se jen o popsání php funkcí ?
díky |
||
Nox Profil |
#2 · Zasláno: 21. 12. 2009, 20:07:22 · Upravil/a: Nox
Máš na mysli asi spíš dokumentaci k nějakému projektu/webu, že?
Spíš než popisy funkcí by mělo být podle mě popsané především jak celý projekt funguje, princip, pak asi jednotlivé komponenty/větší podčásti webu... popis jednotlivých funkcí by neměl být moc potřeba, z předešlého popisu a z jejich názvu by mělo být na první pohled zřejmé, k čemu jsou ... ikdyby to mělo být vyloženě pro programátora, tak stejně kód by měl být tak přehledný, že popis funkce by neměl být třeba, nanejvýš stručný... pokud ne, chtělo by to předělat |
||
Jan Tvrdík Profil |
#3 · Zasláno: 21. 12. 2009, 21:26:44
ananasovapasta:
Pokud zdrojový kód projektu používá phpDoc, tak z něj lze vygenerovat API dokumentaci. |
||
Časová prodleva: 14 let
|
0