C/C++标题和代码文件中的ASCII Art注释

Question

我非常感兴趣地观看了Mojang"Mojam"for Humble Bundle(链接可能在很长一段时间内无效),在整个视频中,我看到了一些关于这些人如何使用他们的代码的好东西.

其中一个原因是其中一个开发人员在他的代码中使用ascii艺术评论来更好地浏览.

这给出了这样的东西:

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

这可能看起来很糟糕,但与Sublime等编辑器相关联,它变得强大,因为Sublime公开的"缩小"视图让您可以轻松阅读该文本并在您的代码中导航.

现在,有很多很酷的ASCII艺术文本的发电机在那里.但是这些(至少我看过的)都没有生成符合C++/C的文本.

含义:我必须手动添加注释斜杠(//)以使其在代码中一致.

你们用这个技巧吗？
如果是,您是否有工具在文本周围生成这些"评论"？

Answer 1

最近,当我在我的.php文件中搜索某个站点的路由列表时,我决定做出如此大的ASCII注释.现在,我使用它们(不是在所有源文件中,但在例如长配置文件中),这些注释确实有助于导航.

以下是我在Sublime Minimap中的表现:

到目前为止,我没有自动创建此类评论的过程.我在这个网站上使用在线ASCII创建者.我用字体"基本"

UPD:Sublime Text的Linux用户可以尝试这个原始但有效的插件:https: //github.com/maslennikov/asciicomments

Answer 2

是的我用来添加那些"导航"提示.特别是在具有许多相似部分但处理即不同消息类型的通信部分中.

我在Mac上工作,所以这里是我的设置.

以前我使用过仪表板小部件 http://memention.com/figlet/

但我最近的事情是用Automator创建一个服务并figlet用自制软件安装.然后在服务中我有这个单行(也点击"输出替换选定的文本")

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

现在在任何应用程序中,只需右键单击一些文本即可获得figlet.

我喜欢的字体是 smslant

然后我通常只是添加/*和*/之后.

编辑

好吧,我刚刚更新了我的服务,添加了C评论

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

Answer 3

没有.我不使用这些东西,会发现这些东西比无用的更糟糕.屏幕=带宽.浪费这样的空间会降低代码的可读性.

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

:-)