J'utilise Sublime Text 3, Atom.io et Bracket.io en tant qu'éditeurs précédents.
J'apprécie aussi beaucoup le nouvel éditeur de code Visual Studio pour Mac.
Existe-t-il des fonctionnalités de commentaire de code similaires à DocBlockr pour Sublime?.
Le code Marketplace de Visual Studio a maintenant une extension de bloc de documentation pour JavaScript et d’autres pourront bientôt être ajoutées. https://marketplace.visualstudio.com/items?itemName=stevencl.addDocComments
Autrefois, il y avait un soutien partiel pour cela. Comme mentionné par d'autres, vous pouvez l'obtenir en tapant /**
puis ENTRÉE, mais uniquement si vous êtes dans un fichier JavaScript. Je ne crois pas que cela fonctionne dans une autre langue.
Quelques fonctionnalités similaires ont été demandées:
À compter d’aujourd’hui, il n’ya pas de version v1.1}, mais c’est une fonctionnalité très votée. Je voterais pour cette fonctionnalité si vous la trouviez utile. @Mattferderer a publié les liens de fonctionnalité auxquels vous devez ajouter vos votes. Jusque-là, il y a 2 plugins qui fonctionnent très bien ensemble:
Document Ceci (ext install docthis
) générera des commentaires de style JsDoc pour de nombreuses annotations de style JsDoc. Utilisez la commande Ctrl + Alt + D
sur ou à l'intérieur de l'endroit où vous souhaitez générer la documentation.
Cela fonctionne bien avec le plugin "Complete JsDoc Tags"
Etiquettes JsDoc complètes (ext install JSDocTagComplete
) Fournit l'achèvement du code pour la plupart des annotations de style JsDoc à l'aide de Ctrl + space
.
L'utilisation de ces 2 plugins ensemble fonctionne vraiment efficacement. DocThis donne le commentaire généré à l'origine avec Ctrl + Alt + D
et peut ensuite utiliser ctrl + space
pour ajouter des annotations JsDoc spécifiques. DocThis ne voit pas/ne génère pas.
Je n'ai pas trouvé le plugin "Ajouter des commentaires JsDoc" @mattferderer mentionne que c'est très utile. Il vous fournit uniquement les balises @param
et @return
et rien d'autre ...
Il termine le bloc si vous tapez /**[enter]
, puis toute saisie dans le bloc est formatée (par exemple, appuyez sur entrée sur une ligne commençant par * et une autre insérée en dessous avec *).
Mais une caractéristique vraiment intéressante de DocBlockr est qu’il scanne le code ci-dessous et ajoute des instructions @param dans le bloc. VS Code ne semble pas le faire.
Si vous tapez /**
puis ENTER et vous obtenez le format doc js dans le code Visual Studio
Si vous voulez des commentaires de paramètres pour des fonctions ou des vides, tapez /// En bonus, ils apparaîtront également dans les points forts de la souris.
Il existe https://marketplace.visualstudio.com/items?itemName=neilbrayfield.php-docblocker .
Ce n'est pas aussi puissant que dans PHPStorm. Mais il peut détecter les paramètres de la fonction et y ajouter des lignes de modèle.