介绍一款VC辅助开发工具VcExtend
2007-03-17 21:26:33 来源:WEB开发网///$分类:类名
注意是中文的分号。象访问控制符一样,后面的函数都会当作是这一类的,直到定义了另一个分类。同一类的函数只能在第一个加分类这个注释项,如果你定了多个同名的类,我可不帮你合并。如果不明白,打开CShow类的头文件,点击CommentDetail调出全部注释,可以很清楚的看到是如何将函数分类的,再看一下CShow的文档,可以看到分类的效果。
后面还提供一些自动化功能,帮你高效地处理注释和文档。
七、注释批处理的魔法----省时高效、随心所欲
注释批处理包括四个命令,它们帮你随心所欲地摆弄注释,并尽可能节省时间。
CommentDetail 显示/隐藏全部注释。这个很简单,试用一下就知道了。
CommentDesc 显示/隐藏注释摘要。这个功能会把所有函数注释的简述部份作为普通注释加在函数声明后面。这样有两方面的作用,一是帮助读者快速的理解类的功能,避免了注释隐藏后完全没有注释的极端,也不会让大量的注释掩没了有效的代码,第二呢,猜到了吗?这是供VC调用的,就是在对象成员列表中弹出函数注释。怎么样?想得很细吧。我的建议是,当一个类的代码完成后,就调用CommentDesc,然后作为最终代码保存。
CommentDetail和CommentDesc是“不兼容”的,互相都会把对方显示的注释先隐藏掉,以避免太多的注释。两者都是开关式的,使用它们,你可以很方便地让你的源文件完全没有注释(成员变量除外),显示全部注释,或是只显示注释摘要。
值得注意的一点是,CommentDesc仅仅是显示注释摘要,在这里作修改,是无法保存到文档中去的。
AttributeComment 为成员变量的读写接口生成注释。如果你给的成员变量写了注释,如: CString m_strName; //RW 主角的名字。 并调用AttributeComment,那么GetName和SetName函数都会自动生成注释,即使你还没有调用CodeCleanUp生成GetSet函数。注释包括简述和返回值注释和参数注释。生成的注释也许并不太合你的心意,但是修改它总比完全重新写它要省时得多。生成的注释会直接保存到文档,而不会在源文件中显示出来,可以调用CommentDetail全部调出来并修改它。不管有多少成员变量,都会一次性生成注释。已经修改并保存的注释,不会重新生成,以免删掉了你的工作成果。
更多精彩
赞助商链接