Spécification de commentaire de code Java Idea

1. Commençons par définir le modèle de classe dans IDEA: (IDEA ajoutera automatiquement des commentaires lors de la création de la classe)

1. Définissez le modèle de commentaire de classe

Fichier> paramètres> Editeur> Modèles de fichiers et de codes> Fichiers

Il y a quatre modèles de classe que nous devons définir, Classe, Interface, Enum, Annotation.
(1) $ {NAME}: Définissez le nom de la classe, qui est le même que le $ {NAME} suivant pour obtenir le nom de classe créé 
(2) TODO: le jeton de la tâche, généralement la classe ou la méthode générée doit ajouter une description 
(3) $ {USER}, $ {DATE}, $ {TIME}: définissez l'utilisateur qui a créé la classe, la date et l'heure de sa création, ce sont les méthodes intégrées dans IDEA, et il y a d'autres méthodes dans la case verte, par exemple, vous voulez ajouter Le nom du projet peut utiliser $ {PROJECT_NAME} 
(4) 1.0: numéro de version

Classe ( les configurations de classe, d'interface, d'énumération et d'annotation sont toutes identiques ):

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
 
/**
*@ClassName     ${NAME}
*@Description   TODO
*@Author        oyc
*@Date          ${DATE} ${TIME}
*@Version       
*/
public class ${NAME} {
}

Deux, modèle d'annotation de méthode de réglage

Idea n'a pas de place pour définir directement le modèle d'annotation de méthode, vous pouvez emprunter des modèles dynamiques pour une implémentation de base. Les étapes sont les suivantes. 

1. Sélectionnez Fichier -> Paramètres -> Editeur -> Modèles en direct, sélectionnez d'abord le signe plus sur la droite pour créer votre propre groupe de modèles, comme indiqué sur la figure, j'ai nommé le groupe de modèles oycJavaGroup;

2. Créez un nouveau modèle, sélectionnez le groupe de modèles nouvellement créé, cliquez sur le "+" à droite et sélectionnez "Modèle en direct"

/**   
 * @Description: $enclosing_method$
 $params$    
 * @return 
 * @throws   
 */

3. Cliquez sur Définir, vérifiez Java 

4. Cliquez sur Modifier les variables pour modifier les variables, définissez comme suit, cliquez sur OK–> Appliquer pour terminer le réglage.

paramètres

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')}; return result", methodParameters())

Autres notes  

  • Annotation de classe:

/**   
 * @ClassName: $ClassName$  
 * @Description: $ClassName$
 * @Author        oyc 
 * @Date $date$ $time$   
 * @Version 1.0
 */

  • journal de l'enregistreur

 private Logger logger = LoggerFactory.getLogger(this.getClass());

 

 

Je suppose que tu aimes

Origine blog.csdn.net/u014553029/article/details/109197196
conseillé
Classement