Πίνακας περιεχομένων:

Πώς γράφετε ένα Javadoc;
Πώς γράφετε ένα Javadoc;

Βίντεο: Πώς γράφετε ένα Javadoc;

Βίντεο: Πώς γράφετε ένα Javadoc;
Βίντεο: Πώς γράφεται ένα παραμύθι-ChrysMarou 2024, Νοέμβριος
Anonim

Πρότυπο κωδικοποίησης Javadoc

  1. Γράψτε Javadoc να διαβαστεί ως πηγαίος κώδικας.
  2. Δημόσιο και προστατευμένο.
  3. Χρησιμοποιήστε το τυπικό στυλ για το Javadoc σχόλιο.
  4. Χρησιμοποιήστε απλές ετικέτες HTML, όχι έγκυρα XHTML.
  5. Χρησιμοποιήστε ένα μόνο

    ετικέτα μεταξύ των παραγράφων.

  6. Χρησιμοποιήστε ένα μόνο
  7. ετικέτα για στοιχεία σε μια λίστα.
  8. Προσδιορίστε μια γερή πρώτη πρόταση.

Από αυτή την άποψη, πώς φτιάχνετε ένα Javadoc;

παρέχετε την έκδοση της κλάσης, της διεπαφής ή του enum. Επιλέξτε «Δημιουργία JavaDoc ” επιλογή από το μενού Project και θα εμφανιστεί ένας οδηγός. Καθορίστε τη θέση για το JavaDoc αρχείο στον υπολογιστή σας, από προεπιλογή θα βρίσκεται στη μονάδα δίσκου C. Επιλέξτε το έργο και μετά τα πακέτα για τα οποία θέλετε να δημιουργήσετε JavaDoc αρχείο.

Στη συνέχεια, το ερώτημα είναι τι είναι τα javadoc και πότε πρέπει να χρησιμοποιούνται; Javadoc είναι ένα εργαλείο που συνοδεύει το JDK και είναι μεταχειρισμένος για τη δημιουργία τεκμηρίωσης κώδικα Java σε μορφή HTML από πηγαίο κώδικα Java, η οποία απαιτεί τεκμηρίωση σε προκαθορισμένη μορφή. */ είναι σχόλια πολλαπλών γραμμών Java. Ομοίως, η γραμμή που προηγείται του // είναι ένα σχόλιο μιας γραμμής Java.

Λαμβάνοντας υπόψη αυτό, τι είναι η εντολή Javadoc;

javadoc είναι ένα εντολή -γραμμικό εργαλείο για την εξαγωγή ειδικών σχολίων (που ονομάζονται σχόλια doc) από αρχεία πηγής java και τη δημιουργία ενός εύχρηστου δέντρου αρχείων HTML που τα περιέχει. Τα σχόλια μπορούν να περιλαμβάνουν τυπική σήμανση HTML και javadoc @tags. Η προδιαγραφή Java API είναι ένα παράδειγμα αυτού javadoc παράγει.

Πώς μπορώ να ανοίξω ένα αρχείο Javadoc;

Για να εντοπίσετε το Javadoc , περιηγηθείτε στον φάκελο Χρήστη (στα Windows 7 αυτό είναι C:Users*Username*), μετά περιηγηθείτε στο sunspotfrcsdk/doc/ javadoc . Κάντε διπλό κλικ στο ευρετήριο. αρχείο html σε Άνοιξε στο προεπιλεγμένο πρόγραμμα περιήγησής σας.

Συνιστάται: