Explication détaillée des spécifications du code pour le développement Java

Les normes de codage à suivre dans le développement Java incluent généralement les 7 points suivants. Spécifications de dénomination, spécifications de commentaires, spécifications de formatage d’indentation, spécifications de nom de fichier, spécifications de déclaration, spécifications d’instructions et spécifications de programmation. [Apprentissage recommandé : Tutoriel vidéo Java]

Convention de dénomination

(1) Tous les. les identifiants ne peuvent utiliser que des lettres ASCⅡ (A-Z ou a-z), des chiffres (0-9) et le trait de soulignement « _ ».

(2) Le préfixe d'un nom de package unique est toujours composé de lettres minuscules. Par exemple : www.tonysun.cc

(3) Le nom de la classe est un nom, en casse mixte, avec la première lettre de chaque mot en majuscule. Par exemple : Tony.

(4) Les règles de casse pour les interfaces sont similaires aux noms de classes : par exemple : Tony.

(5) Le nom de la méthode est un verbe ou une phrase verbale, en casse mixte. La première lettre du premier mot est en minuscule et la première lettre des mots suivants est en majuscule. Par exemple : setNeekeName(StringneekeName).

(6) La première lettre du nom de la variable est en minuscule et la première lettre de tout mot intermédiaire est en majuscule. Les noms de variables doivent être courts et faciles à retenir. Par exemple : neekeName, neekeAddress. Évitez les noms de variables à un seul caractère, à l'exception des variables temporaires à usage unique.

(7) La déclaration des constantes doit être en lettres majuscules, avec "_" reliant chaque mot. Par exemple : finalStringWWW_TONY_CN="www.tonysun.cc";

2. Spécifications du commentaire

( 1 ) les commentaires doivent utiliser "//" autant que possible ; pour tous les commentaires javadoc, utilisez "/***/" et pour les commentaires temporaires sur les blocs de code, essayez d'utiliser "/**/" ".

(2) Tous les fichiers sources doivent avoir un commentaire au début répertoriant le nom du fichier, la date et un aperçu fonctionnel de la classe.

(3) Des commentaires de documentation doivent être ajoutés à chaque méthode (sauf la méthode main() de la classe).

(4) Chaque attribut doit être commenté.

(5) Le code contient au moins 15% de commentaires.

(6) Les commentaires sont en chinois.

3. Spécifications de formatage de l'indentation

(1) Évitez une ligne de plus de 60 caractères.

(2) Utilisez la fonction de formatage du code source d'Eclipse pour compléter l'indentation du code (Ctrl+Shift+F).

4. Spécifications du nom de fichier

(1) Un fichier source Java ne peut stocker qu'une seule classe Java.

(2) Le nom du fichier est le même que le nom de la classe Java.

(3) Les lignes de code d'un fichier de classe ne doivent pas dépasser 200 lignes.

5. Spécifications de déclaration

(1) Déclarez une variable sur une seule ligne.

(2) Ne mettez pas de déclarations de variables de types différents sur la même ligne.

(3) Déclarez uniquement les variables au début du bloc de code.

(4) Toutes les variables doivent être initialisées lors de leur déclaration.

(5) Évitez que les variables locales déclarées n'écrasent les variables déclarées au niveau précédent.

(6) Les méthodes sont séparées par des lignes vides.

6. Spécifications de la déclaration

(1) Chaque ligne contient au moins une déclaration simple.

(2) Dans l'instruction return, la valeur de retour n'est pas entre parenthèses "()".

(3) si les instructions sont toujours placées entre "{" et "}".

(4) Dans la clause d'initialisation ou de mise à jour de l'instruction for, évitez d'augmenter la complexité causée par l'utilisation de plus de trois variables.

(5) Lorsqu'un cas de switch est exécuté vers le bas (car il n'y a pas d'instruction break), des commentaires doivent généralement être ajoutés à l'emplacement de l'instruction break.

7. Spécifications de programmation

(1) Fournir un contrôle d'accès public ou privé aux instances et aux variables de classe, et n'appliquer pas de valeurs par défaut ni de contrôle d'accès protégé comme autant que possible.

(2) Évitez d'utiliser un objet pour accéder aux variables statiques ou aux méthodes d'une classe. Les noms de classe doivent être utilisés à la place.

(3) Évitez d'attribuer la même valeur à plusieurs variables dans une seule instruction.

(4) Utilisez l'instruction switch() pour implémenter plusieurs branches.

(5) Si vous utilisez JDBC, envisagez d'utiliser java.sql.PreparedStatement au lieu de java.sql.Statement.

(6) Le préfixe de la méthode utilisée pour définir l'état de l'objet doit être défini ; le préfixe de la méthode utilisée pour récupérer l'état d'un objet de type booléen doit être is, et le préfixe du La méthode utilisée pour récupérer d'autres méthodes doit être get.

(7) Les nombres (ou caractères) doivent être utilisés le moins possible dans le programme, et les variables statiques doivent être définies autant que possible pour illustrer la signification du nombre (ou du caractère). Lorsqu'une affectation ou une comparaison est requise dans le programme, utilisez les variables statiques définies précédemment. Exception dans le contrôle de boucle.

Cet article provient de la rubrique Introduction Java, bienvenue pour apprendre !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!