Here-docs 可以使你的 Bash 脚本具有自我文档化的功能。

主要观点:长期以来认识到写脚本的价值,能避免他人或未来的自己重新学习和解决问题,但存在困扰,自动化过程同时也是文档记录,二者难以共存,有多种处理方式,倾向于将 markdown 放入 bash 中。
关键信息

  • 可写 bash 脚本用于自动化,写 markdown 文件用于文档,二者易重复信息或不同步,或在单个 markdown 文件中放内联 bash 但运行麻烦。
  • 展示了将 markdown 放入 bash 的方式,如使用 heredoc 及特定语法,可选择自定义分隔符,用 cat 可在运行脚本时打印到终端。
  • 介绍使用 vim 插件 preservim/vim-markdown 实现 markdown 语法高亮等功能,通过添加特定代码到 .config/nvim/after/syntax/sh.vim 来解决在 bash 脚本中默认不支持 markdown 的问题。
    重要细节
  • 分隔符要引号包裹,避免参数扩展或执行,可选择如 -md- 作为分隔符。
  • 对于不同用途,markdown 文件和 markdown 放入 bash 的脚本各有适用场景,如列举 ffmpeg 命令用 markdown 文件,运行手册风格脚本则喜欢 markdown 放入 bash 的方式,现代代码库使用内联文档,bash 脚本也应如此。
阅读 32
0 条评论