Dokumentálása javadoc kód

Amikor dokumentálja az alkalmazás is szükséges támogatást dokumentációs program. Ha a dokumentáció és a kód különálló, véletlenül létrehozott kapcsolatos nehézségek szükségességét módosító vonatkozó szakaszainak dokumentáció, ha megváltoztatja a kódot.

Hogy dokumentáljuk a kódot, akkor HTML-címkéket. Ha a referencia-jellemzőket @see és @link, először meg kell adnia a nevét az osztály, és miután a „#” jel a módszer vagy területen.

IDE fejlesztői környezet általában segíti a programozó „háttérvilágítású” beépített dokumentációval. Az alábbi ábrák a képernyőképek IDE Eclipse felugró ablakokat.

Dokumentálása javadoc kód
Dokumentálása javadoc kód

javadoc segédprogram bemeneti kap egy fájlt a forráskód a program, amely a fájl jön létre NTML. A dokumentáció minden osztály egy külön fájlban NTML. Ezen kívül létrehoz index fa és a hierarchiában. Meg lehet, és a többi NTML fájlokat.

Dokumentumok létrehozásához, akkor ant.

Példaszituáció (feladatok) hangya kialakítására dokumentumok myproject alkalmazás:

Részletek kialakulásának benyújtott dokumentációt a Javadoc / Javadoc2 oldal

Kapcsolódó cikkek