はじめに
初めてQuiitaにブログを書く機会が現れたので、ここに来ました!
現在、自分の技術武器は二つがあります、JavaとAlibaba Cloud。そしてこの二つを組み合わせ、何か書きたかったです。
色々がありますが、今回Alibaba Java Coding Guidelinesについてちょっと紹介したいと思います。
何で?自分のコードもっとキレイにしたいですから!
Alibaba Java Coding Guidelinesとは?
長年にわたるAlibabaの技術チーム内部のベストプログラミングプラクティス。
様々なJavaプログラミングチームが同じルールに則ってプログラミングすることにより、コードクオリティーを高め、お互いのプログラムの再利用と理解を促進しているものです。
このGuidelineは、他のプログラマーも利用できるようGitHubで公開されており、現在2万弱の★がついています。また、アップデートされ続けています。
しかしこのドキュメントは今のところ英語と中国語しか存在していません。
下記に記事の構成をメモします。
このCoding Guidelineは下記の5つに分けられます。
1. プログラミング仕様
2. 例外とログ
3. MySQLの仕様
4. プロジェクト仕様
5. セキュリティ仕様
6.
各仕様は3つのレベルに分類されます。
1. 必須
2. お勧め
3. 参照
詳細は次の通りです。
[説明]:内容説明
[正例]:コーディングと実装が近づい推奨について説明【?】
[反例]:注意事項と実際のエラー事例
具体例
プログラミング仕様
命名規則
[必須] 定数変数名は全て大文字記載、区切りにアンダースコアを用いなければなりません。
各定数変数名は、意味的に完全で明確でなければなりません。
正例:
MAX_STOCK_COUNT
反例:
MAX_COUNT
ドキュメントを読み、自身のコードと比較するのも手ですが、下記プラグインでコードをチェックすることも可能です。(自分のコードに使ったら、結構怒られました)
● PMD implementations
● IntelliJ IDEA plugin
● Eclipse plugin
試験
Alibaba Cloud AcademyにAlibaba Java Coding Guidelinesの試験があります。ドキュメントを読み、実際の知識を試すことができます。試験は無料で、合格したらバッジがもらえます。
試験のリンクはこちらです
おわりに
このベストプログラミングプラクティスは、自分のコードのクオリティーを高めるのにとても役立つものです。潜在的なコードエラーを避けて、最高のコード作れるようになりましょう!
特に私!
最後まで読んで頂き、ありがとうございました。