100 votes

Comment marquer des sections logiques de code dans les commentaires Java?

Des classes Java sont généralement divisés en logique des "blocs". Est-il une convention à l'occasion de ces sections? Idéalement, il serait pris en charge par les grandes IDEs.

Personnellement, j'utilise cette méthode:

//// Section name here ////

Toutefois, certains éditeurs semblent avoir des problèmes avec cela.

Par exemple, dans le code Objective-C, vous pouvez utiliser cette méthode:

#pragma mark -
#pragma mark Section name here

Il en résultera un menu dans XCode qui ressemble à ceci:

alt text

70voto

Olivier Croisier Points 2759

Personnellement, j'utilise de 80 caractères séparateurs de ligne, comme ceci :

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;
    }

}

Bien sûr, cela peut paraître un peu exagéré pour un si petit POJO, mais croyez-moi, il s'est avéré très utile dans certains projets d'envergure où j'ai eu à parcourir par le biais de grands fichiers source et de trouver rapidement les méthodes qui m'intéressait. Il aide aussi à comprendre la structure du code source.

Dans Eclipse, j'ai créé une série de modèles personnalisés (Java -> Editeur -> Modèles dans l'Éclipse de la boîte de dialogue Préférences) qui génèrent ces barres, par exemple. - sepa (Séparateur pour les Accesseurs) - sepp (Séparateur pour les Propriétés) - pec (Séparateur pour les Constructeurs) - etc.

J'ai aussi modifié la norme de la "nouvelle classe" template (Java -> Style de Code -> Modèles de Code dans Eclipse écran des Préférences)

Aussi, il y a un vieux plugin Eclipse appelé Café-octets, ce qui a amélioré la façon dont Eclipse plis des portions de code. Je ne sais pas si elle fonctionne encore, mais je remembed on pourrait définir arbitraire pliable zones en ajoutant des commentaires spécifiques, comme // [SECTION] ou quelque chose. Il peut toujours fonctionner au cours des dernières Eclipse révisions, afin de prendre un coup d'oeil.

14voto

basszero Points 14539

Eclipse définit une annotation @category javadoc ( faites défiler jusqu'à la section marquée "Prise en charge des catégories") qui permet le filtrage par catégorie dans la vue hiérarchique. Pas exactement ce que tu veux. Je suis surpris que personne n'ait écrit un plugin Eclipse qui offre une vue similaire à celle de votre capture d'écran.

6voto

kukudas Points 2049

J'aimais ça aussi quand j'utilisais xcode. Pour eclipse, utilisez ctrl + o (contour rapide) pour naviguer dans une classe Java.

5voto

Teja Kantamneni Points 9112

À l'aide de commentaires inutiles/marqueurs dans le code à l'aide de travail peut être pas une bonne pratique. J'ai une petite idée sur xcode et développement java mais tous les grands de l'IDE en charge la recherche les membres avec toutes les marqueurs spéciaux comme eclipse montre les méthodes et les membres à l'aide de la vue de contour qui peut être déclenché à l'aide de ctrl+O, Intellij (que je préfère à l'aide de plus sur mac et avait un community edition trop) a le même plan concept et peut être rapidement accessible en utilisant (ctrl + f12). Donc, mon point ici est de ne pas utiliser inutilement la marque dans le code comme tous (ou au moins une bonne/sane) IDE peut le faire automatiquement.

4voto

artemb Points 3303

Autant que je sache, il n'existe pas de spécification prise en charge pour regrouper les membres de la classe. Vous pouvez utiliser la convention de commentaire de votre choix, mais il est probable qu'elle ne sera prise en charge par aucun outil.

Il est préférable de regrouper les membres liés dans une classe séparée par héritage ou agrégation. Ceci est considéré comme un bon style de POO

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X