Я использую Sublime Text 3, Atom.io и Bracket.io в качестве предыдущих редакторов.
Мне также очень нравится новый редактор кода Visual Studio для Mac.
Существуют ли функции комментирования кода, подобные DocBlockr для Sublime? Это очень важно для меня, поскольку я комментирую адский код.
В Visual Studio Code Marketplace теперь есть расширение блока документов для JavaScript, а другие могут быть добавлены в ближайшее время. https://marketplace.visualstudio.com/items?itemName=stevencl.addDocComments
Он частично поддерживает это. Как уже упоминалось другими, вы можете получить его, набрав /** и затем ENTER, но только если вы находитесь в файле JavaScript. Я не верю, что это работает на любом другом языке.
Вы можете перенести эту функцию на свой сайт запросов функций. Уже было запрошено несколько аналогичных функций:
На сегодняшний день и выпуском v1.1 не существует, но это очень популярная функция. Я бы проголосовал за эту функцию, если бы вам было удобно, @mattferderer опубликовал ссылки на функции, на которые вы должны добавить свои голоса. До сих пор есть два плагина, которые очень хорошо используются вместе:
Документ This (ext install docthis) создаст комментарии стиля JsDoc для многих аннотаций стиля JsDoc. Используйте команду Ctrl + Alt + D внутри или внутри того места, где вы хотите создать документацию.
Это хорошо работает с плагином "Complete JsDoc Tags"
Завершить JsDoc Tags (ext install JSDocTagComplete) Предоставляет завершение кода для большинства аннотаций стиля JsDoc с помощью Ctrl + space.
Использование этих двух плагинов совместно эффективно работает. DocThis дает исходный сгенерированный комментарий с помощью Ctrl + Alt + D, а затем может использовать Ctrl + space для добавления конкретных аннотаций JsDoc. DocThis не видит/не генерирует.
Я не нашел плагин " Добавить комментарии JsDoc. @mattferderer упоминает, что он очень полезен. Он предоставляет только теги @param и @return и ничего больше...
Он завершает блок, если вы наберете /**[enter], и затем всякая впечатка внутри блока отформатирована (например, нажмите enter в строке, начинающейся с *, а другая будет вставлена ниже с помощью *).
Но одна действительно хорошая функция DocBlockr заключается в том, что она сканирует код ниже и добавляет в блок утверждения @param. Код VS не работает.
Если вы наберете /**, затем нажмите ENTER и вы получите формат js doc в визуальном студийном коде
Если вам нужны комментарии параметров для функций или пустот, просто введите /// в качестве бонуса они будут отображаться также в основных моментах мыши.
Существует https://marketplace.visualstudio.com/items?itemName=neilbrayfield.php-docblocker.
Это не так сильно, как в PHPStorm. Но он может обнаруживать функциональные параметры и добавлять для него шаблонные строки.