Основное форматирование текста в визуальных студийных комментариях? - PullRequest
0 голосов
/ 10 мая 2018

В течение десятилетий комментарии c, c ++ c # были простым текстом ASCII.

Есть ли способ сделать базовые комментарии в стиле Rich Text в c #? Просто простые вещи, такие как маркеры или пронумерованные точки, жирный шрифт, курсив и отступы, не более того. Это сделало бы мои комментарии намного проще для чтения. Похоже, мир перешел от базовой ASCII, но комментарии c # остались позади

1 Ответ

0 голосов
/ 10 мая 2018

Ну, комментарии C # - просто текст. Если вы хотите использовать какое-либо форматирование, вы должны каким-то образом его кодировать (разметка, префикс, теги XML) и использовать какое-то расширение, чтобы показать его отформатированное в Visual Studio.

Я не знаю, нужно ли вам форматирование только для вас при чтении исходного кода или для документации, сгенерированной из комментариев. Для последнего случая есть стандартный доступный способ - комментарии XML. Используйте для маркированных и нумерованных списков.

Конечно, вы не видите форматированный текст непосредственно в VS. Однако вы можете просмотреть или отредактировать такой комментарий в VS с помощью Редактора комментариев WYSIWYG , включенного в VSdocman (я являюсь автором этого расширения).

...