源代码指南

在代码注释中使用 ASCII Banner

把 ASCII 艺术字用作源代码分区标题,同时避免破坏语法、代码检查规则和行宽约定。

为什么使用文本 Banner?

ASCII Banner 最适合标记真正重要的代码边界,例如生成代码、独立子系统、协议阶段,或者开发者不应手动修改的文件。

请选择紧凑字体,并让输出保持在项目规定的行宽以内。当格式化工具限制为 80 或 100 列时,Small 和 Ogre 是实用的起点。

一个安全的起始模式

/*
  ____ ___  ____  _____
 / ___/ _ \|  _ \| ____|
| |  | | | | |_) |  _|
| |__| |_| |  _ <| |___
 \____\___/|_| \_\_____|
*/

为编程语言选择正确包装

JavaScript、TypeScript、Go、Rust、Java、C 和 C++ 可以使用块注释;Shell、Python、Ruby 和 YAML 可以使用 # 前缀导出。生成器会处理意外出现的注释结束序列。

注意代码格式化工具

一些格式化工具会重新排列长注释。请只在工具能够原样保留文本块的位置使用装饰标题,或者按照工具文档排除这一小段区域。

生成你的版本

打开完整字体库,输入最终文字并设置目标宽度,然后使用适合当前工作流的包装格式复制结果。