20191122日记

晚8点到9点

在极客时间上卖桃者说145期学习了关于写好注释的一个说明，链接如下：

http://gk.link/a/10bn7

注释的三种类型：第一种类型，是记录源代码版权和授权的；第二种类型，是用来生成用户文档的（这里学习了Java doc，使用命令行可以把Java源码里按照格式写的注释生成api）；第三种类型，是用来解释源代码的。

注释的三个原则

准确，错误的注释比没有注释更糟糕。

必要，多余的注释浪费阅读者的时间。

清晰，混乱的注释会把代码搞得更乱。

©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容