Комментарии ASCII Art в заголовках и файлах C/С++

Я с большим интересом наблюдал за Mojang "Mojam" для Humble Bundle (ссылка может быть недействительна в течение длительного времени), и на протяжении всей видео, я видел некоторые замечательные вещи о том, как эти парни используют свой код.

Одна из этих вещей заключалась в том, что один из разработчиков использует комментарии ascii в своем коде, чтобы лучше ориентироваться.

Это дает что-то вроде этого:

/////////////////////////////////////////////
//      ___  ___       ___   _   __   _    //
//     /   |/   |     /   | | | |  \ | |   //
//    / /|   /| |    / /| | | | |   \| |   //
//   / / |__/ | |   / / | | | | | |\   |   //
//  / /       | |  / /  | | | | | | \  |   //
// /_/        |_| /_/   |_| |_| |_|  \_|   //
//                                         //
/////////////////////////////////////////////
int main()
{
    // do some stuff
    return 0;
}

Это может выглядеть плохо там, но связано с такими редакторами, как Sublime, оно становится мощным, потому что "уменьшенное" представление, которое Sublime expos позволяет читать этот текст и перемещаться по вашему коду как легкий ветерок.

Теперь есть много классных текстовых генераторов текстовых изображений ascii там. Но ни один из них (по крайней мере, я смотрел) не генерировал текст, совместимый с С++/C.

Смысл: мне нужно вручную добавить косых комментариев (//), чтобы сделать это в коде.

Вы, ребята, используете этот трюк? Если да, есть ли у вас инструмент для создания этих "комментариев" вокруг текста?

Ответы

Ответ 1

Да, я использую, чтобы добавить эти типы "навигационных" сигналов. Специально в частях связи, которые имеют много одинаковых частей, но обрабатывают различные типы сообщений.

Я работаю на Mac, поэтому здесь идет моя настройка.

Раньше я использовал виджет панели инструментов http://memention.com/figlet/

Но моя последняя вещь - создать Сервис с Automator и установить figlet с homebrew. Затем в службе у меня есть этот однострочный (также щелкнув "Выход заменяет выделенный текст" )

/usr/local/bin/figlet -f smslant -w 132

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

Мой предпочтительный шрифт smslant

Затем я обычно добавляю /* и */ после.

Изменить

Ну, я только что обновил мою Сервис, чтобы добавить этот комментарий C

( echo "/*" ; /usr/local/bin/figlet -f smslant -w 132 ; echo " */" )

Ответ 2

Недавно, когда я искал что-то в моем .php файле со списком маршрутов для сайта, я решил сделать такие большие комментарии ASCII. И теперь я использую их (не во всех исходных файлах, но, например, в длинных файлах конфигурации), и эти комментарии действительно помогают ориентироваться.

Вот как он выглядит в моей Sublime Minimap:

enter image description here

До сих пор я не автоматизировал процесс создания таких комментариев. Я использую онлайн-создателя ASCII из этого сайта. Я использую шрифт "basic"

UPD: Пользователи Linux Sublime Text могут попробовать этот необработанный, но рабочий плагин: https://github.com/maslennikov/asciicomments

Ответ 3

НЕТ. Я не использую такие вещи и считаю такие вещи хуже, чем бесполезные. Экран = ширина полосы. Таким образом, использование такого пространства уменьшает читаемость кода.

            ______
||\   ||   /      \
|| \  ||   |      |
||  \ ||   |      |
||   \||   \______/

: -)

Ответ 4

Если вы используете SublimeText, я предлагаю попробовать ASCII Decorator. Его легко установить, он не требует ничего, кроме Sublime, и он работает на каждой ОС. Кроме того, у него много хороших шрифтов!