Movatterモバイル変換


[0]ホーム

URL:


酒と泪とRubyとRailsと

Javaのコーディング規約


Javaの代表的なコーディング規約へのリンクです。

commons/styleguide.md at master · twitter/commons

TwitterのJavaコーディング規約です。英語ですが、読みやすい文章です。参考になった記述をいくつかピックアップします。

🐡ドキュメント

宣言的な文章ではなく、完結で理解を手助けするようなコメントを書く。読み手の正確な理解を手助けします。

/**
* A volatile storage for objects based on a key, which may be invalidated and discarded.
*/
classCache{
...
}

メソッドの説明では入力の引数がとても大切。

/**
* Splits a string on whitespace. Repeated whitespace characters are collapsed.
*
*@param s The string to split. An {@code null} string is treated as an empty string.
*@return A list of the whitespace-delimited parts of the input.
*/
Listsplit(String s);

オーバーライドしたメソッドは、オーバーライド元のメソッドとの違いをコメントすべきです。

classTwitterDatabaseimplementsDatabase{
/**
* Semantic version number.
*
*@return The database version in semver format.
*/
@Override
public StringgetVersion(){
...
}
}

🐮参考リンク

🖥 VULTRおすすめ

VULTR」はVPSサーバのサービスです。日本にリージョンがあり、最安は512MBで2.5ドル/月($0.004/時間)で借りることができます。4GBメモリでも月20ドルです。 最近はVULTRのヘビーユーザーになので、「ここ」から会員登録してもらえるとサービス開発が捗ります!

📚 おすすめの書籍

概要はじめに基本概念初心者向け入門資料整数(int, log)文字(char)文字列(String)コレクションと配列マップ(Map)セット(Set)日付(Date)列挙(Enum)バイト(byte)正偽型(boolean)プリミティブ型と参照型Optional型文法修飾子クラスメソッド例外処理初期化ブロック変数インタフェースについてリフレクションswitch文Comparable I/Fアノテーションイテレータ(iterator)Stream API/LambdaSpring Framework概要Hello WorldDI(依存性の注入)アスペクト指向プログラミングデータバインディングと型変換Controllerアノテーションフォーム利用プロパティ(設定値)管理バリデーションライブラリThymeleaf(テンプレート)Lombok(ボイラープレート)Jackson(JSONライブラリ)MyBatis(OR Mapper)JUnit(ユニットテスト)HibernateデザインパターンファクトリパターンシングルトンパターンテンプレートメソッドパターンTipsJavaのBest PracticeJavaのコーディング規約IntelliJ IDEAノウハウJSPについてJava Tips

[8]ページ先頭

©2009-2025 Movatter.jp