Klasszikus API-doksi (tehat generalt) -bol a legjobb az openfire -e amivel eddig talalkoztam - http://www.igniterealtime.org/builds/openfire/docs/latest/documentation…
Ez volt kb. az egyetlen kod, aminek megbocsatottam a javadoc-okat.
Altalaban ugy vagyok vele, ha meglatok egy ilyet:
/** persists the CV record sent to the professional specified by ID.
* returns true if succeeded
* @param JobUploaderID The ID of the job uploader
* @return boolean
*/
public boolean saveAttachment(int JobUploaderID){...
Akkor alapvetoen az jut eszembe, hogy ha azt csinalja, nevezd el annak, ill. tanulj meg exceptionoket dobni, meg azonos neveket hasznalni.
A JavaDoc sok helyet foglal, es olyan szinten kell ertelmesnek lenni, mint az OpenFire doksijanak, hogy megerje. Kulonben en speciel elkezdem olvasni a forrast.
Nagyon szeretem az atnezodolgokat, sajna a mai programozok tobbsege nem tud olvasni (aminek egy sajnalatos mellekkovetkezmenye, hogy irni se, plane kodot), a PHP kodpeldak mondjuk tenyleg sokat tudnak segiteni az embereknek, igaz, sajna abbol esznelkuli copy-pasta lesz sokaknak, de hat ez mar nem az API doksi iro baja.
GMaps doksit is erdemes megnezni.
Playgroundok se rossz dolgok dinamikus rendszereknel, vagy olvashato tesztek (Jasmine pl), helyzetfuggo.
A konkret program (API) feladataihoz kepest egyszerubb lenne ajanlani.
GMaps API doksira nezz ra esetleg.