零、怎么编写注释
编写注释的方式有三种:
1.以#开头
2.以三个‘开头和结尾
3.以三个“开头和结尾
单引号和双引号注释中出现了:para 参数名:和return:,param是对每个参数的描述,return是对返回值的描述
一、规则
注释具有两个功能:
1.对所编写的代码解释说明
2.表明编写代码的思路
结合以上两点,我们在编写代码的时候应遵循简单、明了。所谓简单明了,就是指要用简练的语言清晰的描述出代码所要做的事情/编写代码的思路。还应注意的是,#注释一般用于函数/方法内的代码注释,单引号和双引号注释一般用于函数/类/方法本身的注释
二、 小结
本节主要讲解了注释的写法,这些规则在开发中经常使用,请读者牢记注释的规则。在本章结束后我将留作业,届时可以将各位的作业发送到指定的邮箱或者群里。
领取专属 10元无门槛券
私享最新 技术干货