Bash脚本中文档样式的标准是什么?

linusthe3rd:

我目前正在编写一个具有许多功能的Bash脚本,并希望添加文档以使其他团队成员了解该功能的意义。

是否有用于记录Bash脚本及其包含的功能的标准“样式”?

移动:

通常,我会尝试遵循与我在其他语言(例如C)中使用的准则类似的准则。

这包括一个函数头,其中包含:

  • 功能名称,简短描述和用途
  • 参数和返回值列表以及说明
  • 所有副作用的列表(例如,变量或文件的更改)

本文收集自互联网,转载请注明来源。

如有侵权,请联系 [email protected] 删除。

编辑于
0

我来说两句

0 条评论
登录 后参与评论

相关文章

Spark SQL的SQL标准是什么?

将日期编码为时间戳的标准是什么?

Typescript中使用引号的标准是什么?

在JSON中定义空对象的标准是什么

在子类中引发异常的标准是什么

KLOC在每个测试阶段的成功标准是什么?

codeigniter中查询编写的标准是什么

当前数据库案例的标准是什么

处理时区的移动行业标准是什么?

可存储类型的确切标准是什么?

python对象的正确和错误标准是什么?

使用Azure DevOps开发Azure Sql的标准是什么?

在gcc中包含语言的标准是什么?

toString实现的最佳标准样式是什么?

关于匿名名称空间和内部链接的标准是什么?

有效电子邮件的Symfony 2的@Assert \ Email验证标准是什么?

自动化测试用例的行业标准是什么?

解析字符串以使其浮动的python标准是什么?

Go中多词结构类型的命名标准是什么?

将rDNS分配给未使用的主机的标准是什么?

选择定价时,Hadoop分销下的AWS EMR Amazon标准是什么

YAML 标准是什么?我只是谷歌,但我找不到答案

降价列表缩进3个空格还是4个空格?标准是什么?

在Kotlin中选择“何时”与“是否/其他”的标准是什么?

GCP中使用Stackdriver Kubernetes Engine监控的日志条目的度量标准是什么?

如何确定C ++编译器的默认标准是什么C ++?

发送有关资源的额外信息的JSON:API标准是什么?

在 Java 中创建等待线程的 main() 循环的黄金标准是什么

在 Windows 机器上安装 ubuntu 的行业标准是什么?

TOP 榜单

热门标签

归档