Могу ли я разместить что-то вроде комментария или аннотации рядом со свернутым кодом в Visual Studio?

#visual-studio #comments

#visual-studio #Комментарии

Вопрос:

Если вы свернете блок закомментированного кода в Visual Studio, это вполне нормально. Вы получите небольшое поле, содержащее [ // ... ] указание на наличие свернутого комментария, и вы можете навести на него курсор мыши, чтобы увидеть небольшое всплывающее окно с тем, что внутри. Вместо того, чтобы каждый раз наводить курсор мыши, есть ли способ просто добавить однострочный комментарий выше или ниже [ // ... ] блока, не пытаясь включить его в свернутый раздел Visual Studio?

Например, при попытке выполнить следующее:

    //this is a brief description of the collapsed code below
   [ // ... ]
 

Затем Visual Studio помещает верхний комментарий в свернутый раздел ниже, делая его бесполезным, если вы не наведете на него курсор мыши. Таким образом, это потенциально экономит некоторое время, но не устраняет необходимость наведения курсора мыши; иногда просто проще прочитать одну строку, чтобы запомнить, что что-то делает, и тем лучше, если вам не нужно перепрыгивать через дополнительный обруч, чтобы прочитать эту одну строку.

Вы могли бы просто сделать что-то подобное, пропустив строку:

 //this is a brief description of the collapsed code below

[ // ... ]
 

И это работает так, как я бы этого хотел — без свертывания всего вместе — но это дополнительное пространство между строками выглядит просто странно, и необходимость делать это потенциально несколько раз в программе только удлиняет все это. Любой совет?

Ответ №1:

Если вы хотите, чтобы комментарий служил напоминанием или кратким текстом для другого блока свернутого кода комментария, скажем, в случае, если вы хотите сохранить какой-то код, прежде чем решить, редактировать его или удалять, это можно сделать одним из по крайней мере двух способов в Visual Studio. Во-первых, очевидная разница между типами комментариев:

Разница между однострочным и многострочным комментарием

Существует разница в том, как среда IDE Visual Studio обрабатывает два типа комментариев. Однострочные комментарии могут стоять отдельно или могут быть сгруппированы вместе с другими однострочными комментариями для формирования сворачиваемого блока, но блок нельзя разделить на группы однострочных комментариев без пропуска строк между ними. Многострочные комментарии всегда можно свернуть, но их индикаторы /* */ соединяются, подобно тому, как { } символы соединяются в коде.

Тем не менее, типы комментариев можно комбинировать, по крайней мере, следующими способами для формирования напоминаний / сводок.

Первый:

один или несколько однострочных комментариев в качестве напоминания для многострочных

который сворачивается следующим образом:

изображение выше со свернутым комментарием

и второе:

многострочный комментарий в качестве напоминания для многих однострочных строк

который сворачивается следующим образом:

изображение выше со свернутыми комментариями

Еще раз обратите внимание, что многострочные комментарии всегда можно свернуть, поэтому в более длинных фрагментах кода может быть легко потерять расположение строк, если они случайно свернуты.