Share
Această lecție rapidă acoperă Javadoc, un instrument util pentru generarea de documente din fișierele sursă Java. Această lecție face parte dintr-o serie continuă de tutoriale pentru dezvoltatorii care învață Java pentru a dezvolta aplicații Android.
Javadoc este un utilitar furnizat cu Java SDK care permite dezvoltatorilor să genereze documentație de cod din fișierele sursă Java. Mediile de dezvoltare precum Eclipse au suport integrat pentru Javadoc și pot genera materiale de referință HTML de căutare din comentariile în stil Javadoc. De fapt, referința Android SDK este o formă de documentație Javadoc.
Documentația Javadoc utilizează o combinație de procesare a codului sursă (și de inspectare a tipurilor, parametrilor etc.) și citirea unor etichete de comentariu speciale pe care dezvoltatorul le oferă ca metadate asociate unei secțiuni de cod.
Un comentariu în stil Javadoc trebuie să vină chiar înainte de codul în care este asociat. De exemplu, un comentariu Javadoc pentru o clasă trebuie să fie chiar deasupra declarației de clasă, iar un comentariu pentru o metodă trebuie să fie chiar deasupra declarației metodei. Fiecare comentariu ar trebui să înceapă cu o scurtă descriere, urmată de o descriere mai lungă a opțiunii. Apoi puteți include un număr de etichete diferite de metadate, care trebuie furnizate într-o anumită ordine. Unele etichete importante includ:
De asemenea, puteți crea propriile etichete personalizate pentru utilizare în documentație.
În timp ce scrieți cod în Eclipse, puteți genera un comentariu în stil Javadoc selectând elementul pe care doriți să-l comentezi (numele unei clase, numele metodei etc.) și apăsând Alt-Shift-J (Cmd-Shift-J pe un Mac). Acest lucru va crea un comentariu de bază în stil Javadoc pentru ca dvs. să completați detaliile.
Să ne uităm la un exemplu. Iată un simplu comentariu Javadoc care descrie o clasă:
/ ** * Activitate pentru încărcarea resurselor planului * * Această activitate este utilizată pentru a afișa diferite resurse de structură pentru un tutorial pe designul interfeței utilizator. * * @author LED * @version 2010.1105 * @ de la 1.0 * / clasa publica LayoutActivity se extinde Activitatea
Iată ce va arăta când generați documentația Javadoc:
Să ne uităm la un exemplu. Iată un simplu comentariu Javadoc care descrie un câmp dintr-o clasă:
/ ** * Etichetă de depanare pentru folosirea loggerului la debug la LogCat * / String final static privat DEBUG_TAG = "MyActivityDebugTag";
Iată ce va arăta când generați documentația Javadoc:
Acum, să aruncăm o privire asupra a două exemple de comentarii despre metodă. Iată un simplu comentariu Javadoc care descrie o metodă în cadrul unei clase:
/ ** * Metoda care adauga doua intregi impreuna * * @ param a Primul intreg de adaugat * @param b Cel de-al doilea intreg de adaugat * @return Suma rezultata a a si b * / public int addIntegers (int a, int b ) retur (a + b);
Acum, să aruncăm o privire asupra unei metode care revine nevalid, dar aruncă o excepție:
/ ** * Această metodă aruncă pur și simplu o excepție dacă parametrul de intrare a nu este un număr pozitiv, doar pentru distracție. * * @param a Indiferent dacă ar trebui să aruncați o excepție * @raste excepția * / public void throwException (boolean shouldThrow) aruncă Excepție if (shouldThrow == true) arunca o nouă excepție ();
Iată cum va arăta atunci când generați documentația Javadoc pentru aceste două metode:
Pentru a genera documentația codului Javadoc în Eclipse, accesați meniul Project și alegeți opțiunea "Generați Javadoc ...". Aceasta va lansa un expert care vă permite să alegeți proiectele pentru a genera documentația pentru.
Din acest expert, ar trebui să indicați Eclipse la instrumentul corespunzător al liniei de comandă javadoc.exe (îl veți găsi în directorul JDK / bin). De asemenea, puteți configura anumite setări ale documentației, cum ar fi documentarea întregului cod sau numai clase vizibile, membrii etc. În final, alegeți o destinație pentru fișierele de documentare.
Chiar și fără a genera fișierele Javadoc, Eclipse va afișa documentația în stil Javadoc atunci când treceți peste metodele și altele asemenea, după cum se arată în figura de mai jos.
Puteți afla mai multe din referința Javadoc de pe site-ul Oracle. Există, de asemenea, un ajutor Javadoc util.
În această lecție rapidă ați învățat despre Javadoc, un instrument puternic folosit de dezvoltatorii Java pentru a documenta codul sursă în mod temeinic pentru scopuri de referință și întreținere. Eclipse, mediul de dezvoltare utilizat de mulți dezvoltatori Android, are suport integrat pentru Javadoc.
Dezvoltatorii mobili Lauren Darcey și Shane Conder au coautorizat mai multe cărți despre dezvoltarea Android: o carte de programare în profunzime intitulată Dezvoltarea aplicațiilor fără fir Android și Sams TeachYourself Dezvoltarea de aplicații Android în 24 de ore. Când nu scriu, își petrec timpul dezvoltând software-ul mobil la compania lor și oferind servicii de consultanță. Acestea pot fi obținute prin e-mail la androidwirelessdev@[email protected], prin intermediul blogului lor la androidbook.blogspot.com, și pe Twitter @ androidwireless.
Accentsconagua