web-dev-qa-db-fra.com

Comment personnaliser NetBeans PHP auto DocBlock pour les méthodes et les attributs?

Après avoir créé une méthode, j'utilise /**<enter> pour générer le DocBlock. Il remplit automatiquement le @param et le @return pour cette fonction. Exemple:

/**
 *
 * @param type $str
 * @return type 
 */
public function strlen($str){
    return strlen($str);
}

Comment puis-je personnaliser le bloc en cours de création pour qu'il remplisse également le @author et se termine avec celui-ci après le /**<enter>

/**
 *
 * @param type $str
 * @return type 
 * @author John Doe <[email protected]>
 */
public function strlen($str){
    return strlen($str);
}

Merci

phpnetbeansdocumentationdocblocks
33
bxfckrclooo

Il existe peut-être un meilleur moyen de le faire, mais voici ce que j'ai utilisé: sous Outils> Options> Editeur> Modèles de code, il existe des combinaisons prédéfinies pour générer rapidement du code. L'un des modèles par défaut de la version 7.0 est:

vdoc<tab>

Cela génère un pseudo-docblock et la définition de variable. Vous pouvez remplacer ceci et en ajouter de nouveaux qui se développent dans le texte de votre choix, un peu comme les abréviations de vim. Vous pouvez trouver plus d'informations à ce sujet sur le site de documentation Netbeans:

http://netbeans.org/kb/docs/php/code-templates.html#using-templates

5
Bryan Agee

Je pense que la réponse que vous cherchez se trouve ici: Tutoriel phpDocumentor

Je pense que vous voudrez regarder le commutateur de ligne de commande --customtags.

Donc, très probablement, lorsque vous allez dans Outils -> Options -> "PHP" -> "PHPDoc", vous pouvez ajouter cette option de ligne de commande --customtags à la ligne de script PHPDoc.

Je n'ai pas essayé personnellement, mais je me suis amusé à l'idée d'utiliser NetBeans en combinaison avec DocBlocks et PHPDocumentor pour créer "automatiquement" une bonne quantité de documentation utilisable sans être trop - Difficile sur le reste des codeurs. ;-)

Un didacticiel vidéo intéressant sur la configuration de NetBeans pour qu’il fonctionne avec PHPDocumentor est disponible ici: Génération de PHP Documentation avec NetBeans IDE 7.0

4
russsaidwords

Pour activer l'auto-complétion correcte des balises @author, allez simplement dans: Outils-> Modèles-> PHP-> Classe PHP, appuyez sur le bouton "Paramètres" et décommentez la ligne commençant par #user=. Vous pouvez maintenant modifier le nom et l'adresse électronique, qui sont transmis à votre commentaire de classe.

3
zinovyev

Réponse courte de diverses sources: Non, vous ne pouvez pas modifier un modèle qui pourrait l’ajouter pour vous.

  1. Si vous recherchez toujours une fonctionnalité identique, vous pouvez créer un Macro do et lui associer un raccourci ("Alt + W" par exemple).

Pour créer une Macro : Outils -> Options -> Editeur -> Macros

Exemple :

Alt+W => insert-break "/**" insert-break

Cette macro permet d’ajouter PHPDoc avec la main gauche, ce qui le rend plus rapide. Vous pouvez générer ce que vous voulez générer, par exemple en utilisant cette macro, puis en plaçant le curseur au bon endroit, puis en ajoutant le @author YOUR_NAME à la fin du commentaire.

  1. Vous pouvez également définir l'auteur général de votre projet en allant dans: Outils -> Modèles; Cliquez sur "Paramètres"

Ajouter la ligne:

user=YOUR NAME <email.prefix at domain.extension>

Ceci ajoutera le @author à toutes vos nouvelles définitions de classe/interface.

J'espère que cela t'aidera!

0
aneth101