14

我非常感兴趣地观看了Humble Bundle 的 Mojang “Mojam”（链接可能在很长一段时间内无效），并且在整个视频中，我看到了这些人如何使用他们的代码的一些很棒的事情。

其中之一是开发人员在他的代码中使用 ascii 艺术注释来更好地导航。

这给出了这样的结果：

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

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

现在，有很多很酷的 ascii 艺术文本生成器。但是这些（至少我看过的）都没有生成符合 C++/C 的文本。

含义：我必须手动添加注释斜杠 ( //) 以使其在代码中运行。

你们会用这个技巧吗？
如果是，您是否有工具可以围绕文本生成这些“评论”？

4

5 回答 5

13

最近，当我在我的 .php 文件中搜索包含站点路由列表的内容时，我决定进行如此大的 ASCII 注释。现在，我使用它们（不是在所有源文件中，但例如在长配置文件中），这些注释确实有助于导航。

这是它在我的 Sublime Minimap中的外观：

在此处输入图像描述

到目前为止，我还没有自动化创建此类评论的过程。我使用此站点的在线 ASCII 创建器。我使用字体“基本”

于 2012-03-02T16:32:34.180 回答
11

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

我在 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 " */" )
于 2012-02-20T14:37:41.493 回答
7

不。我不使用这些东西，并且会发现这些东西比没用更糟糕。屏幕=带宽。像这样浪费空间会降低代码的可读性。

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

:-)

于 2012-02-20T14:35:37.183 回答
4

如果您使用的是 SublimeText，我建议您尝试ASCII Decorator。它很容易安装，除了 Sublime 之外不需要其他任何东西，它适用于每个操作系统。另外，它有很多漂亮的字体！

于 2013-08-14T08:12:24.387 回答
0

尝试支持#pragma 标记的IDE？ http://cocoasamurai.blogspot.co.uk/2006/09/tip-pragma-mark-organizing-your-source.html

于 2013-02-25T15:07:28.073 回答