ASCII Art комментирует в C / C ++ заголовках и файлах кода - PullRequest
14 голосов
/ 20 февраля 2012

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

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

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

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

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

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

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

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

Ответы [ 5 ]

13 голосов
/ 02 марта 2012

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

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

enter image description here

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

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

10 голосов
/ 20 февраля 2012

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

Я работаю на 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 " */" )
5 голосов
/ 20 февраля 2012

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

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

: -)

2 голосов
/ 14 августа 2013

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

0 голосов
/ 25 февраля 2013

попробуйте IDE, которая поддерживает #pragma mark?http://cocoasamurai.blogspot.co.uk/2006/09/tip-pragma-mark-organizing-your-source.html

...