Ввод / ** / в файлах PHP
Я использую /**/ в качестве личного маркера для битов кода, которые необходимо обработать перед фиксацией. Как только я наберу это:
/**
… Редактор думает, что мне нужен докблок, и запускает автозаполнение:
/**| */
… Где | - это курсор. Таким образом, когда я набираю последнюю косую черту, я наконец получаю:
/**/| */
Это происходит с несколькими установленными расширениями PHP (включая PHP DocBlocker и PHP Extension Pack Феликса Беккера), а также с --disable-extensions, поэтому он должен запускаться встроенным автозаполнением.
Есть ли параметр, который я могу настроить, чтобы предотвратить это?
Возможно, было бы проще изменить стиль кодирования - большинство людей используют / ** TODO: любой * /.
/** обычно используется в IDE для комментариев к документации. См. Phpdoc.org
@Tschallacka Именно поэтому нужно использовать другой маркер. Я хочу быть уверенным, что обнаруживаю незаконченный код с первого взгляда, поэтому не передаю его в систему контроля версий. Я не хочу просматривать все задачи в рамках проекта, чтобы каждый раз рассказывать свои.
@Barmar Конечно, /**/ не является допустимым док-блоком, потому что он пуст :) В других редакторах, которые я использовал, автозаполнение выполнялось только при вводе пробела, табуляции или последующего ввода.
Да, PhpStorm так работает. Думаю, VSCode немного более агрессивен.
Ответы 2
Вы должны использовать
// TODO some_description_of_what_to_do
или же
/** TODO some_description_of_what_to_do */
Это общепринятое обозначение чего-либо.
Вы можете опустить часть описания и просто пометить ее как
// TODO*
// or
/** TODO */
Большинство IDE (наверняка PhpStorm) выделяют такой комментарий, и вы сможете увидеть его еще лучше. Также есть возможность при фиксации через IDE проверять наличие отметок TODO перед фиксацией.
Просто попробуйте, и вы заметите, насколько это удобно;)
P.S .: Если вы используете Visual Studio Code https://marketplace.visualstudio.com/items?itemName=wayou.vscode-todo-highlight
В кодовой базе, над которой я сейчас работаю, есть 102 таких маркера, и это небольшой проект. Вводить туда мои временные маркеры - безумная идея ...
Насколько я могу судить, вот как работает эта функция, и нет параметр, чтобы настроить или даже отключить ее. Таким образом, я открыл запрос функции: # 51047 autoClosingPairs слишком агрессивны. (autoClosingPairs задействован, потому что он обрабатывается так же, как и скобки.)
В качестве обходного пути я создал собственный фрагмент кода:
"/**/": {
"prefix": "/**/",
"body": "/**/",
"description": "Workaround to be able to type /**/"
}
Мне нужно только быть осторожным и набрать / + Enter (или / и Tab), но как только вы к этому привыкнете, это действительно сэкономит ваше время.
Соглашение заключается в том, чтобы ввести
//TODO some comment what to do, тогда большинство сред автоматически поместят его в список TODO, где вы можете щелкнуть, чтобы перейти к этому блоку кода.