Πώς να Αφήστε σχόλια σε Java Code

Σχόλια είναι ένα ισχυρό εργαλείο . Μπορούν να χρησιμοποιηθούν για να δημιουργήσουν ολόκληρο διεπαφή προγραμματισμού εφαρμογών ( API ) τεκμηριώσεις με εργαλεία όπως το javadoc , δίνουν μικρές συμβουλές σε δύσκολες μέρη του κώδικα , ή απλά να περιγράψει αυτό που ο κωδικός είναι έτοιμος να κάνει . Όταν αφήσετε σχόλια σε κώδικα Java , μπορείτε να δείτε επίσης έναν αναγνώστη που δεν γνωρίζει τη γλώσσα ακριβώς ποιος είναι ο κωδικός κάνει . Οδηγίες
Η 1

Αφήστε σύντομο , μονής γραμμής σχόλια να πω κάτι γρήγορα πριν από μια μικρή ομάδα γραμμών . Μικρά σχόλια περιγράψει το τι γίνεται σε γενικές γραμμές " κομμάτια ". Ένας προγραμματιστής θα γράψει συχνά αυτά τα σχόλια πρώτα και να πάει πίσω για να συμπληρώσετε τον κωδικό αργότερα , τον βοήθησε να εδραιωθεί η διανοητική εικόνα του πώς ο κώδικας θα λειτουργήσει πριν από τη συγγραφή του, καθώς και τον εντοπισμό τυχόν ατέλειες στη λογική πριν από τη σύνταξη του κώδικα .

2

Γνωρίστε τη μορφή για αφήνοντας σχόλια μονής γραμμής . Είναι γνωστή από το "//" " " //Σύνδεση με το = νέα TCPSocket ServerSocket s ()? S.connect . ( "Example.com" , 80 ) ;//Αίτηση για την files.write ( " GET /HTTP /1.0 \\ r \\ n \\ r \\ n " ) ? απάντηση string = s.read ( ) ;//ήταν η αίτηση επιτυχημένη κωδικό int = get_code (απάντηση) ? ! εάν (κωδικός = 200 ) επιστρέφει -1 ;//Download η filedownload_file ( s ) ? " "
εικόνων 3

Χρησιμοποιήστε πολλαπλών γραμμών σχόλια όταν έχετε περισσότερα να πει ό, τι θα ταιριάζει σε μια ενιαία γραμμή . Τα σχόλια πολλαπλών γραμμών βρίσκονται συνήθως στην κορυφή των μεθόδων που περιγράφουν τη συνολική λειτουργία , πώς λειτουργεί και τι παραμέτρους που χρειάζεται . Είναι, επίσης, μερικές φορές σε εντοπισμένες περιοχές του κώδικα ο προγραμματιστής είχε πρόβλημα με ένταλμα ή σκέφτεται σε βάθος συζήτηση .
Η 4

Σημειώστε τη γενική μορφή των παρατηρήσεων multi-line . Κατά σύμβαση , κάθε γραμμή αρχίζει με αστερίσκο . Οι μόνες συγκεκριμένες απαιτήσεις μορφή είναι ότι το σχόλιο αρχίζει με /* και τελειώνει με * /. " " /* Αυτό το μέρος ήταν πραγματικά δύσκολο . Έπρεπε να χαράξει * αυτήν την τιμή για να ταιριάζει με τους άλλους . * Ίσως θα επανέλθω σε αυτό το κωδικό για να * βρει έναν καλύτερο τρόπο για να το κάνετε αυτό , αλλά για τώρα * αυτό λειτουργεί , αλλά δεν είναι αρκετά . * /" "
5

Γνωρίστε τη μορφή σχολίων Javadoc . Αρχίζουν με /** και περιέχουν μετα- ετικέτες που μοιάζουν @ αυτό . Τα σχόλια Javadoc βρίσκονται κυρίως πριν από τις μεθόδους . "" /*** Υπολογίζει την κλίση μιας γραμμής . @ ** Συγγραφέας Jack Smith * @ param p1 Πρώτο σημείο που περιγράφει τη γραμμή * @ param p2 Δεύτερο σημείο που περιγράφει τη γραμμή Slope * @ επιστροφή της γραμμής ως float * /" "
εικόνων