Shell编程规范-关于注释
关于注释
除脚本首行外,所有以 开头的语句都将成为注释。
函数必须有注释标识该函数的用途、入参变量、函数的返回值类型,且必须简单在一行内写完。
函数的注释 顶格写, 井号后面紧跟一个空格 ,对于该格式的要求是为了最后生成函数的帮助文档是用的(markdown语法),然后是注释的内容,注释尽量简短且在一行,最后跟的是函数的类型。
函数内注释 与缩进格式对整齐
变量的注释紧跟在变量的后面
- 发表于:
- 原文链接：http://kuaibao.qq.com/s/20180301G039NC00?refer=cp_1026
- 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号（企鹅号）传播渠道之一，根据《腾讯内容开放平台服务协议》转载发布内容。
- 如有侵权，请联系 cloudcommunity@tencent.com 删除。
相关快讯
扫码
添加站长 进交流群
领取专属 10元无门槛券
私享最新 技术干货
腾讯云开发者
