Javaコメントでコードの論理セクションをマークする方法は？

Javaクラスは通常、論理的な「ブロック」に分割されます。これらのセクションをマークする規則はありますか？理想的には、それは主要なIDEによってサポートされるでしょう。

私は個人的にこの方法を使用しています：

//// Section name here ////

ただし、一部の編集者はこれに問題があるようです。

例として、Objective-Cコードでは、このメソッドを使用できます。

#pragma mark -
#pragma mark Section name here

これにより、XCodeのメニューは次のようになります。

私は次のように80文字の行区切り文字を個人的に使用しています。

public class Client {

    //================================================================================
    // Properties
    //================================================================================

    private String name;
    private boolean checked;

    //================================================================================
    // Constructors
    //================================================================================

    public Client() {
    }

    public Client(String name, boolean checked) {
        this.name = name;
        this.checked = checked;
    }

    //================================================================================
    // Accessors
    //================================================================================

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public boolean isChecked() {
        return checked;
    }

    public void setChecked(boolean checked) {
        this.checked = checked;
    }

}

もちろん、これはそのような小さなPOJOには少々やり過ぎに思えるかもしれませんが、大きなソースファイルを参照して興味のあるメソッドをすばやく見つける必要があるいくつかの巨大なプロジェクトでは非常に役立つことがわかりました。ソースコードの構造。

Eclipseでは、これらのバーを生成する一連のカスタムテンプレート（Java->エディター-> Eclipseの[設定]ダイアログの[テンプレート]）を作成しました。-sepa（アクセサ用のSEParator）-sepp（プロパティ用のSEParator）-sepc（コンストラクタ用のSEParator）-など

標準の「新しいクラス」テンプレートも変更しました（Java->コードスタイル-> Eclipse設定画面のコードテンプレート）

また、Eclipseがコードの一部を折り畳む方法を強化したCoffee-bytesと呼ばれる古いEclipseプラグインもあります。それでも機能するかどうかはわかりませんが、// [SECTION]などの特別なコメントを追加することで、任意の折りたたみ式ゾーンを定義できることを思い出しました。最近のEclipseリビジョンでも動作する可能性があるので、見てください。

intellij / android studioには素晴らしいソリューションがあります。
で始まる：
//region Description
で終わる：
//endregion

そのショートカットは、Command+ Alt+ T（Mac）またはCtrl+ Alt+ T（Windows）で開くことができるメニューにあります。

必要に応じて、独自の線を追加して視覚的に分離することもできます。リージョンは、他の関数と同様に+/-ボタンを使用して自由に縮小および拡張できます。Command+ Alt+ Period（Ctrl+ Alt+ Period）で地域間を移動することもできます

ソース。

例：

//region Parceler Implementation
//---------------------------------------------------------------------------------------
@Override
public int describeContents() {
    return 0;
}

@Override
public void writeToParcel(Parcel dest, int flags) {
    dest.writeParcelable(this.die, 0);
    dest.writeParcelable(this.dieSprite, 0);
}

private DieVm(Parcel in) {
    this.die = in.readParcelable(Die.class.getClassLoader());
    this.dieSprite = in.readParcelable(Sprite.class.getClassLoader());
}

public static final Parcelable.Creator<DieVm> CREATOR = new Parcelable.Creator<DieVm>() {
    public DieVm createFromParcel(Parcel source) {
        return new DieVm(source);
    }

    public DieVm[] newArray(int size) {
        return new DieVm[size];
    }
};
//---------------------------------------------------------------------------------------
//endregion

Eclipseは、@ category javadocアノテーション（「Category support」とマークされたセクションにスクロール）を定義します。これにより、アウトラインビューでカテゴリによるフィルタリングが可能になります。まさにあなたが望むものではありません。スクリーンショットのようなビューを提供するEclipseプラグインを誰も作成したことがないのではないでしょうか。

私はxcodeを使用していたときもそれが好きでした。Eclipseの場合、ctrl + o（クイックアウトライン）を使用してJavaクラスをナビゲートします。

コードで不要なコメント/マーカーを使用して作業を支援することは、良い方法ではないかもしれません。私はxcodeとJava開発についてほとんど考えていませんが、Eclipseのような特別なマーカーなしでメンバーを見つけるすべての主要なIDEのサポートはctrl+O、Intellij を使用してトリガーできるアウトラインビューを使用してメソッドとメンバーを示しています（これはMacでより多く使用することを好み、コミュニティ版も）は同じアウトラインの概念を持ち、（ctrl + f12）を使用してすばやくアクセスできます。したがって、ここでの私のポイントは、コード内で不要なマークアップを使用しないことです。これは、IDEがすべて自動的に実行できるためです。

私の知る限り、クラスメンバーをグループ化するためのサポートされている仕様などはありません。好きなコメント規則を使用できますが、どのツールでもサポートされない可能性があります。

関連するメンバーを、継承または集約によって別のクラスにグループ化することをお勧めします。これは良いOOPスタイルと見なされます

提供されたAndreyの回答に加えて、// region // endregionを使用するには、主要なコードセクションに[BigAscii文字] [1]を挿入します。速くスクロールするとき、それは本当に際立っています。このアプローチの欠点の1つは、検索できないことです。そのため、以下のように「バナー」のすぐ下に検索語を追加する必要があります。

ブロッククォート

//    _      _____          _____                  _   _
//   | |    |  __ \   /\   |  __ \      /\        | | | |
//   | |    | |  | | /  \  | |__) |    /  \  _   _| |_| |__
//   | |    | |  | |/ /\ \ |  ___/    / /\ \| | | | __| '_ \
//   | |____| |__| / ____ \| |       / ____ \ |_| | |_| | | |
//   |______|_____/_/    \_\_|      /_/    \_\__,_|\__|_| |_|
//
//   Search here with: LDAP Auth

[1]：http : //patorjk.com/software/taag/#p=display&c=c%2B%2B&f=Big&t=LDAP Auth

私はjavadocを使用します。または、以下を単純な「セパレータ」として使用します（単一または3行）：

/** RecyclerOnItemClickListener */

/** 
 * RecyclerOnItemClickListener
 */

そのため、IDEでは、目立たないコメントのグレー以外の別の色で表示されます。

最新のIDEでは、さまざまな方法でコードを表示し、コードを再編成することもできます。Eclipseでは、カーソルを置いたコードの定義を別のパネルに表示することもできます。

コードを自動的に再編成すると、そのようなマークアップが機能しなくなります。

グループ化したい場合は、同じクラスに属しているものと、異なるクラスに属していないものを一緒に配置することを検討してください。

メソッドをクラスター化できる場合は、セクションでキャプチャーするその概念専用の別のクラスを実行します。ファイルの作成は無料です。

IntelliJの場合、次のようにします。

        public void ________________INIT__________________() {};

ファイル構造がきれいに見えます！