メソッドの記述順序について

前提・実現したいこと

メソッドの記述順番についてふと気になったので，皆様に質問いたします．

私の場合
C　→　Java
と移行してきた人間なので，

C
1void a(){
2  // Do Something...
3}
4
5void b(){
6  a();
7  // Do something...
8}

といったように，先に使われる関数を先に定義するクセがついております．

しかし，Javaの場合，メソッドの記述順序に制約がないので，ふとした時にメソッドの記述順序に悩んでしまいます．（どう書くのが読みやすい親切なコードなんだろう）

package
import static
import
class
public static final field
private static final field
...

のような形式でご回答いただくけると，読みやすくて助かります．

皆様のご意見，お聞かせください．（理由がついているととても嬉しいです．）

行動規範の内容に同意します

回答2件

ベストアンサー

チームで作業しているならば、コーディング規約で決まってそうな気がしますが。

Google Java Style Guide

Ordering of class contents
The order you choose for the members and initializers of your class can have a great effect on learnability. However, there's no single correct recipe for how to do it; different classes may order their contents in different ways.

What is important is that each class uses some logical order, which its maintainer could explain if asked. For example, new methods are not just habitually added to the end of the class, as that would yield "chronological by date added" ordering, which is not a logical ordering.

論理的な順序を持つことが重要。

Javaコーディング規約

4.16 メンバー順序
以下の順で記述する

staticフィールド
staticイニシャライザー
staticメソッド
フィールド
イニシャライザー
コンストラクター
メソッド
同一カテゴリー内では以下の可視性の順で記述する

public
protected
パッケージprivate
private

投稿2018/08/04 01:14

umyu

総合スコア5846

chankane

2018/08/04 01:37

わたしの場合， staticフィールド staticイニシャライザーフィールドイニシャライザー staticメソッドコンストラクターメソッドの順で今まで記述しておりました．フィールドはフィールドでまとめるパターンですね(^^) なるほど static なものの定義は先に済ませておくぱたーーんですかちなみにその考え方の理由（個人の意見でも結構です）をお伺いしたいのですが，ご教授願えますでしょうか？

chankane

2018/08/04 01:38

すみません．「ぱたーーん」ではなく「パターン」ですね．誤字失礼いたしました．

umyu

2018/08/04 02:25

@chankaneさんへコメント欄は右側に編集ボタンがあるので、追記せずとも修正できます。ご参考まで個人的な考え方としてはそのクラスを使用している人がまず何をみるかですかねー。 static 変数(フィールド)、コンストラクタ、publicメソッド、ここらへんは見るけど、クラスの内部実装である、インスタンス変数はprivateメソッドは見るのはあとになるのではないでしょうか。例えば、JavaDocのIntegerクラスなら以下のようにstaticフィールド、コンストラクタ、alphabet順にstaticメソッド、インスタンスメソッド）になっています。 https://docs.oracle.com/javase/jp/8/docs/api/java/lang/Integer.html

chankane

2018/08/04 02:34

＞コメント欄は右側に編集ボタンがあるので、追記せずとも修正できます。ご参考までお恥ずかしい限りです(〃－〃)ﾎﾟｯ＞個人的な考え方としてはそのクラスを使用している人がまず何をみるかですかねー。 static 変数(フィールド)、コンストラクタ、publicメソッド、ここらへんは見るけど、クラスの内部実装である、インスタンス変数はprivateメソッドは見るのはあとになるのではないでしょうか。納得がいきます．たしかにここのページにお世話になるときのことを思い出せば，プライベートフィールドなんてしったこっちゃですものね．なんだかすきっりしました．ありがとうございますm(__)m

行動規範の内容に同意します

public なものを先に書いて、private なものを後にする位で、それより細かい粒度は気にしないです。

クラスの概要、提供する機能を概観したい場合に public なメソッドが先に書いてあるとよいでしょう。
public メソッドが使われる順番はクラスを定義する側からは「知ったことではない」状態であるべきです

投稿2018/08/04 00:55

koko_u

総合スコア936

chankane

2018/08/04 01:07

ほほう．自分の書いたコード例とは逆ですね．＞クラスの概要、提供する機能を概観したい場合に public なメソッドが先に書いてあるとよいでしょう。 public なメソッドは直接提供する機能なので（＝優先度が高い）スクロールしないと見えない後側ではなく先に記述するべき．という解釈でよろしいですか？また，＞public メソッドが使われる順番はクラスを定義する側からは「知ったことではない」状態であるべきですすみません，ここをもう少しだけ具体的にお願いします (m´・ω・｀)m

koko_u

2018/08/04 01:19

public なメソッドは他のクラスから自由に好きな順序で呼び出し可能であるべき、という意味です。

chankane

2018/08/04 01:29

なるほど，その点は考えたことがなかったです．たしかに public な a を実行してからでないと public な b が実行できないとなると不便ですし，ほかの方にも迷惑をかけますよね(´・ω・`)...勉強になりました．

行動規範の内容に同意します

あなたの回答