介绍一款VC辅助开发工具VcExtend
2007-03-17 21:26:33 来源:WEB开发网Comment的基本用法已经在前面说过了。它是一个开关式的多功能的命令,当你光标下的函数还没有注释时,使用它会生成注释模板,当已经有注释时,使用它会保存并隐藏注释,当你的函数已有注释但隐藏了时,会调出注释供你阅读和修改,当你在编辑cpp或inl文件时,也可以用它调出注释来查看或修改,当你的光标在头文件的类声明行或其上方的任一行时,操作的就是类注释!
注释项分为三部份,一是全自动处理的,完全不用理会它。包括:类注释的类名,基类名,文件名;函数注释的函数名,函数原形,这部分不会在源文件中显示出来,但可以在文档中显示。二是必选项,包括类注释的简述,函数注释的简述,简述就是最简单的功能描述,如果连这个都不写的话,你这个注释也就没什么意义了。函数注释的返回值和参数项也属于这一类,但不写这两项注释还比较无所谓。三是可选项,你可以增删一些项目,如说明就是可选的。可选项的增删方法参见后面的关于选项的章节。
生成注释模板时,Comment并不是直接贴个模板了事,而是先进行了一些分析的。重载函数会当作一个函数,所有的参数都会收集起来。如果你为多个重载函数写了多份注释,后保存的就会覆盖先保存的。同名的函数,即使不是连续声明,也会当作重载函数。
类模板中的[]内的返回类型或参数,千万不要删掉它。你的注释加在它后面就是了。用空格隔开比较好看一些。
如果你修改了函数,如加了参数,或加了重载的函数,可以把当前的注释保存,再调出来,就会把新加的参数加入模板。
当注释隐藏时,实际上是保存到Doc目录下的Doc.xml文件上去了。隐藏和保存是同时进行的,所以修改后最好隐藏一下,虽然你不隐藏,注释还在你的源文件上,不会丢失,但当你在cpp文件上打开相应的注释时,只会调出已经保存过的内容,并且,没保存的注释不会出现在文档上。这些操作,可以使用注释批处理功能,参见后续章节。
更多精彩
赞助商链接