Можно ли комментировать комментарии

Question

Я испытываю это неудобство при комментировании. Но мне было интересно, как вы, ребята, сделаете это. Допустим, у вас есть следующий код:

/*Fancy function*/
function fancyFunction(){
 echo "Oh yeah"
 //200 more lines go here
}

А теперь я хочу прокомментировать всю функцию, вы сделаете это:

/*

/*Fancy function*/             <--Comment breaks here
function fancyFunction(){
 echo "Oh yeah"
 //200 more lines go here
}
*/

Как ты это делаешь xD

Answer 1

Комментирование предназначено, чтобы дать вам комментарии для вашего кода.Система, сообщающая вам и другим разработчикам причину принятия решений или что-либо еще неочевидное при чтении самого кода.

Лучше всего будет удалить данный код.Если вы используете контроль версий (и вы должны это сделать), вы никогда не потеряете код.

Answer 2

Я думаю, что нет простого способа обойти это, но вот полезный совет для быстрого комментирования:

// /*
function foo()
{
    // do something
}
// */

Теперь, когда вы хотите закомментировать функцию, просто удалите первые две косые черты:

/*
function foo()
{
    // do something
}
// */

Однако я настоятельно не рекомендую этот стиль.Это выглядит ужасно, и вместо этого следует использовать управление версиями, как уже упоминалось ранее несколько раз.

Answer 3

Как уже упоминалось ранее, долгосрочная стратегия состоит в том, чтобы полагаться на систему контроля версий, в противном случае все может стать очень запутанным, особенно при попытке закомментировать 200 строковых функций (которые, вероятно, следует разбить на более мелкие, чтобы их было легче читать функции).

Однако, сказав это, я также обнаружил, что мне нужно временно закомментировать функцию, одновременно тестируя что-то еще, и это дополнительная нагрузка для отскока назад и вперед между ревизиями VCS и т. Д.

Обычно я комментирую только с использованием строковых комментариев (// ...), даже для многострочных комментариев, и я исключительно использую блочные комментарии (/ * ... * /) для этого стиля временных замен функций.

Answer 4

Вам необходимо использовать однострочный комментарий в каждой строке, например,

///*Fancy function*/
//function fancyFunction(){
// echo "Oh yeah"
// //200 more lines go here
//}

Многие используемые мной редакторы имеют функции для комментирования / снятия комментария с выделенного текста таким образом.Например, в блокноте ++ в контекстном меню выберите «переключить комментарий к блоку».

Answer 5

Я использую однострочные комментарии "//comment".

Если вы получаете хорошую IDE, вы можете прокомментировать несколько строк, нажав одну комбинацию клавиш.Вы также можете комментировать комментарии:

// comment
function xyz();

прокомментировал:

// // comment
// function xyz();