折叠注释会降低可读性
使用折叠到定义功能,连注释都被折叠,会降低注释提高可读性的作用。
折叠后,不能看到详细描述。
这样写注释,就不会被折叠
普通说明的注释
每行都单独用/*.......*/
的方式注释。
//......
和/*......*/
轮流使用,也能不被折叠。
函数的注释
推荐使用方法一。虽然占篇幅,但我个人觉得可读性反而更好,而且不影响函数注释的显示效果。
方法一(推荐)
将原注释每两行之间用如图的内容(在自带格式的三个斜杠后面紧跟输入/**/
)隔开。缺点:标签内不能换行,必须要单行写完。
和原来相同的参数提示:
和原来相同的函数提示:
方法二
用/*.......*/
注释。
缺点:是填写参数时,依旧显示所有注释,不会切换成只显示单个参数的注释。