À propos des directives de codage Java d'Alibaba

introduction

Je suis venu ici parce que j'ai eu l'occasion d'écrire un blog sur Quiita pour la première fois! Actuellement, j'ai deux armes techniques, Java et Alibaba Cloud. Et je voulais écrire quelque chose en combinant ces deux. Il y a plusieurs choses, mais cette fois je voudrais vous présenter un peu les directives de codage Java d'Alibaba. Pourquoi? Je veux rendre mon code plus beau!

Que sont les directives de codage Java d'Alibaba?

Meilleures pratiques de programmation au sein de l'équipe technique d'Alibaba au fil des ans. Diverses équipes de programmation Java programment selon les mêmes règles pour améliorer la qualité du code et promouvoir la réutilisation et la compréhension mutuelles des programmes.

Cette directive a été publiée sur GitHub pour une utilisation par d'autres programmeurs, et est actuellement marquée d'un peu moins de 20 000 ★. Je suis. Il est également en cours de mise à jour. Cependant, ce document est actuellement disponible en anglais et chinois. maître /% E9% 98% BF% E9% 87% 8C% E5% B7% B4% E5% B7% B4Java% E5% BC% 80% E5% 8F% 91% E6% 89% 8B% E5% 86% 8C % EF% BC% 88% E5% 8D% 8E% E5% B1% B1% E7% 89% 88% EF% BC% 89.pdf) n'existe que. Notez la structure de l'article ci-dessous.

Ce guide de codage peut être divisé en cinq catégories.

1. Spécifications de programmation
2. Exceptions et journaux
3. Spécifications MySQL
4. Spécifications du projet
5. Spécifications de sécurité

Chaque spécification est divisée en trois niveaux.

1. Obligatoire
2. Recommandé
3. Référence

Les détails sont les suivants. [Explication]: Description [Bon exemple]: Le codage et la mise en œuvre approchent, et l'explication des recommandations [? ] [Contre-mesure]: précautions et cas d'erreur réels

Exemple concret

Spécifications de programmation

Règles de dénomination

[Obligatoire] Les noms de variables constantes doivent être écrits en majuscules et doivent être séparés par un trait de soulignement. Le nom de chaque variable constante doit être sémantiquement complet et clair.

Exemple normal: MAX_STOCK_COUNT

Contre-mesure: MAX_COUNT

Vous pouvez lire la documentation et la comparer avec votre propre code, mais vous pouvez également vérifier le code avec le plugin ci-dessous. (J'étais assez en colère quand je l'ai utilisé dans mon code) ●　PMD implementations ●　IntelliJ IDEA plugin ●　Eclipse plugin

tester

L'Alibaba Cloud Academy a un examen pour les directives de codage Java d'Alibaba. Vous pouvez lire la documentation et tester vos connaissances. L'examen est gratuit et vous recevrez un badge si vous réussissez.

Le lien de l'examen est ici

en conclusion

Cette meilleure pratique de programmation peut être très utile pour améliorer la qualité de votre code. Évitez les erreurs de code potentielles et soyez capable d'écrire le meilleur code!

** Spécialement moi! ** **

Merci d'avoir lu jusqu'au bout.