| Autor | Zpráva | ||
|---|---|---|---|
| ger Profil * |
#1 · Zasláno: 31. 7. 2010, 00:40:36
Ahoj. Dost často vídám v kódech různých projektů stejně napsané komentáře. Např. z roundcubemail:
/**
* Object constructor
*
* @param string Username (to managesieve login)
* @param string Password (to managesieve login)
* @param string Managesieve server hostname/address
* @param string Managesieve server port number
* @param string Enable/disable TLS use
* @param array Disabled extensions
*/
Nechce se mi věřit že by to tam každý psal ručně, určitě existuje program který to psaní komentářů ulehčí. Jak se ten program jmenuje? ... a musí to být něco co poběží pod linuxem. |
||
| joe Profil |
#2 · Zasláno: 31. 7. 2010, 00:52:55
Třeba NetBeans to umí. Stačí napsat metodu/funkci a pak nad její hlavičku napsat /** a odentrovat. A PHPDoc je na světě.
|
||
| mckay Profil |
#3 · Zasláno: 31. 7. 2010, 00:53:54
ger:
Netbeans, máš tam přímo při vytvoření nového souboru návod, jak si ten text tam upravit. |
||
| Alphard Profil |
#4 · Zasláno: 31. 7. 2010, 01:33:00
ger:
Umí ti asi každé vývojové studio, osobně mám také zkušenosti s NetBeans. Ale chci hlavně odkázat http://www.phpdoc.org/, nebo přímo manuál. PHPDoc, stejně jako JavaDoc, umožňuje následné vygenerování manuálu, i když s tím jsem se v praxi moc nesetkal. |
||
| Joker Profil |
#5 · Zasláno: 31. 7. 2010, 10:10:31
ger:
„Nechce se mi věřit že by to tam každý psal ručně, určitě existuje program který to psaní komentářů ulehčí.“ Že to vypadá stejně je dané spíš tím, že PHPdoc standardizuje ty tagy, než že by to všichni dělali tím samým programem. Jak bylo zmíněno, umí to snad každé vývojové prostředí, ale ono není těžké to psát i ručně. Zrovna v PHP jsou možnosti toho automatického generování omezené, protože je třeba problém automaticky rozpoznat datový typ argumentů funkce/metody. joe: „Třeba NetBeans to umí. Stačí napsat metodu/funkci a pak nad její hlavičku napsat /** a odentrovat. A PHPDoc je na světě.“ Úplně stejně i v Eclipse. |
||
| rixi Profil |
#6 · Zasláno: 31. 7. 2010, 10:53:36
zvyknu sa dokumentovat aj jednotlive premenne alebo konstanty, ze naco sluzia?
|
||
|
Časová prodleva: 14 let
|
|||
0