On dit que la nomination capacité mais aussi tenir compte du programme d'alphabétisation de base d'un programmeur. Je suis en faveur de cette phrase! En tant que développeur ne peut pas échapper au nom de ceci, aussi grand que le nom du projet, le nom module, petits noms de classe, les noms des méthodes, les noms de paramètres, les noms de paramètres, les noms de variables. Le nom et joue une des décisions clés sur la qualité et la lisibilité du code.
Comment code de haute qualité? En fait, le nom pas si difficile, la clé de votre poids ne font pas attention, prêts à passer du temps. Ce qui suit est l'élaboration de manuels et notes de cours Alibaba dans cette partie de la part applicable elle.
notes de cours
-
Depuis combien de temps le nom le plus approprié?
Un principe nommé capable d'exprimer avec précision leur signification peut être. nom long peut pointer n'a pas d'importance.
-
Nommé à lire, rechercher
Ici, on pouvait lire, en se référant à la nécessité d'utiliser un mot anglais spécial rare de nom. Interrogeable à l'aide des outils de développement intelligents fonctions d'association. Par exemple, tapez l'acquisition d'un objet « .get », IDE retournera toutes les méthodes commençant par Get et ainsi de suite. Par exemple:
-
Procédé d'obtention d'un objet unique avec un préfixée Get
-
L'acquisition d'une pluralité de méthodes d'objet avec le préfixe GetList
-
L'acquisition d'une pluralité de méthodes d'objet avec le préfixe GetCount
-
La méthode d'insertion est précédée d'économie d'insertion /
-
Supprimer la méthode préfixé avec supprimer / supprimer
-
Procédé de modification préfixé par jour
-
Une fonction de combien est-elle appropriée?
Une fonction de quelques centaines de lignes, ce qui indique quoi? La logique est trop compliqué, lire le code, il est facile d'oublier dos regardé en face. En fait, la capacité de mieux refléter la logique et la capacité d'affiner un programmeur! Pour fonctionner seul principe de responsabilité, une scission raisonnable! Nous ne pouvons pas quantifier la fonction spécifique de la taille, l'Internet a un dicton, qui ne dépassent pas une hauteur verticale de l'écran. Probablement la fonction est d'environ 50 lignes.
-
Remarque Comment écrire? Naming est important, des commentaires tout aussi importants avec un nom. Certaines personnes pensent qu'un bon nom peut remplacer le commentaire. Personnellement, je pense que ce point de vue un peu trop extrême. Nommé meilleur, après tout, des restrictions de longueur, ne peut pas assez détaillé, cette fois, le commentaire est un bon complément. Le but est de faire un commentaire sur le code plus facile à comprendre.
Ali Guide du développeur nommé la section des commentaires (légèrement modifié)
-
Code [forcé] appelé utilisation interdite Pinyin mélangé avec l'anglais, mais ne permet pas l'utilisation directe de la mode chinoise. Description: l'orthographe et la grammaire anglaise correcte permet aux lecteurs faciles à comprendre, éviter toute ambiguïté. Notez que la dénomination même purement phonétique doit être évitée.
-
[Obligatoire] Les noms de classe, les noms de méthode utilisent le style UpperCamelCase, mais les circonstances exceptionnelles suivantes: DO / BO / DTO / VO / UID et ainsi de suite.
-
Nom du paramètre [Obligatoire], les variables membres, les variables locales sont de style uniforme de l'utilisation lowerCamelCase, doit se conformer à la forme de bosse.
-
[Obligatoire] constante nommant majuscules, séparés par un tiret entre les mots, l'intégrité sémantique et nous nous efforçons d'effacer, nom pas trop long.
-
[Obligatoire] utiliser le nom abstrait de classe abstraite ou le début de la base, la classe d'exception nommée à l'aide des fins d'exception, classe de test nommé d'après le nom de sa classe à tester début à la fin du test.
-
[Forced] pour éliminer complètement les abréviations non standard, ce qui signifie que je ne sais pas pour éviter de regarder le texte. Anti Exemple: AbstractClass « abrégé » nommé AbsClass, condition « en abrégé » nommé Condi, comme l'acronyme aléatoire dégrade sérieusement la lisibilité du code.
-
[Recommandé] Si les modules, interfaces, classes, méthodes d'utilisation du modèle de conception, la nécessité de refléter le modèle de nommage spécifique. Description: Un modèle de conception se reflète dans le nom, aider à comprendre rapidement le concept de conception architecturale.
-
[Référence] ENUM nom de classe est recommandé d'apporter le suffixe Enum, les besoins de l'énumération des noms de membres pour être en majuscules, séparés par un tiret entre les mots.
Description: Enumeration est en fait une classe spéciale, les membres de domaine sont des constantes, et est forcé de constructeur par défaut est privé.
notes Statut
-
[Force] toutes les méthodes abstraites (y compris l'interface méthodes) Remarque, en plus de la valeur de retour, les paramètres, les exceptions dit, il faut noter que la méthode de faire quelque chose, pour atteindre quelles fonctions.
Description: atteindre les exigences sous-classe, ou les précautions d'appel, s'il vous plaît expliquer aussi.
-
[Obligatoire] Toutes les classes doivent être ajoutées le créateur et la date de création.
-
[Obligatoire] méthode interne de commentaires sur une ligne dans la déclaration ci-dessus est un commentaire sur une ligne distincte, en utilisant // commentaires. Le procédé d'utilisation de l'observation multi-ligne interne / * * / observation et notez que le code est aligné.
-
[Obligatoire] tout le champ de type énuméré doit avoir une note sur l'objectif de chaque élément de données.
-
[Recommandé] avec son « demi-cuite » en anglais aux commentaires, comme l'annotation chinoise effacer le problème. Les noms propres et mots-clés peuvent conserver le texte original en anglais. Contre-exemple: « délai de connexion TCP » interprété comme « connexion de protocole de contrôle de transmission a expiré », mais la compréhension brainer.
-
[Recommandé] changements de code dans le même temps, les commentaires doivent être modifiés en conséquence, en particulier, les paramètres, les valeurs de retour, une anomalie, la logique de base et d'autres modifications. Description: Notes mises à jour de code ne sont pas synchronisées, comme le réseau routier et la mise à jour du logiciel de navigation ne synchronise pas le même, si le logiciel de navigation est sérieusement en retard, a perdu le sens de la navigation.
-
[Référence] Pour connaître les exigences des notes de bas: tout d'abord, la réaction peut être concevoir avec précision et logique de code, d'autre part, ce qui signifie en mesure de décrire le service, de sorte que d'autres programmeurs d'apprendre rapidement le code derrière l'information. Aucun commentaire n'a été pour les grandes sections du lecteur de code comme hiéroglyphique, le commentaire est pour vous-même, même si séparé depuis longtemps, mais aussi une compréhension claire à ce moment-là l'idée, note aussi regarder à son successeur, afin qu'il puisse prendre rapidement sur leur propre travail.
-
[Référence] bon nom, la structure du code est explicite, les commentaires soient simples et d'expression précise en place. Pour éviter l'émergence d'un commentaire extrême: logique nombre excessif de commentaires, de toute révision du code, modifier la note est un lourd fardeau.
Enfin, il y a un très important, qui est, les projets, les équipes, et même la société, nous devons élaborer une norme de codage unifié, et superviser la mise en œuvre du Code Review, qui ont un effet immédiat sur l'amélioration de la qualité du code.
