文件名称:
编写Ruby代码注释时需要注意的一些问题
开发工具:
文件大小: 45kb
下载次数: 0
上传时间: 2021-01-21
详细说明:写出自解释文档代码,然后让这部分歇息吧。这不是说着玩。
使用英文编写注释。
使用一个空格将注释与符号隔开。
注释超过一个单词了,应句首大写并使用标点符号。句号后使用 一个空格
避免多余的注释。
# bad
counter += 1 # increments counter by one
随时更新注释,没有注释比过期的注释更好。
不要为糟糕的代码写注释。重构它们,使它们能够“自解释”。(Do or do not – there is no try.)
注解应该写在紧接相关代码的上方。
注解关键字后跟一个冒号和空格,然后是
(系统自动生成,下载前可以参看下载内容)
下载文件列表
相关说明
- 本站资源为会员上传分享交流与学习,如有侵犯您的权益,请联系我们删除.
- 本站是交换下载平台,提供交流渠道,下载内容来自于网络,除下载问题外,其它问题请自行百度。
- 本站已设置防盗链,请勿用迅雷、QQ旋风等多线程下载软件下载资源,下载后用WinRAR最新版进行解压.
- 如果您发现内容无法下载,请稍后再次尝试;或者到消费记录里找到下载记录反馈给我们.
- 下载后发现下载的内容跟说明不相乎,请到消费记录里找到下载记录反馈给我们,经确认后退回积分.
- 如下载前有疑问,可以通过点击"提供者"的名字,查看对方的联系方式,联系对方咨询.