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.
*/
class Cache {
...
}

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

/**
* 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.
*/
List<String> split(String s);

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

class TwitterDatabase implements Database {
/**
* Semantic version number.
*
* @return The database version in semver format.
*/
@Override
public String getVersion() {
...
}
}

🚌 参考リンク

📚 おすすめの書籍