介绍一款VC辅助开发工具VcExtend
2007-03-17 21:26:33 来源:WEB开发网核心提示: 每一个注释项都是以///$加标签名开头的,如果要换行,介绍一款VC辅助开发工具VcExtend(9),从第二行开始,要用///开头,对函数进行分类,同一类的函数的声明要放在一起,千万不要用///$,否则会当作是一个新的项
每一个注释项都是以///$加标签名开头的,如果要换行,从第二行开始,要用///开头,千万不要用///$,否则会当作是一个新的项,也不要用//开头,否则会认为格式不规范而拒绝存入。如果注释较长,应该分多行来写,就象代码一样。多行注释可以先写成普通文字,写完后用MultiLineComment命令来处理。因为注释是要用来生成文档的,而文档的显示环境与在源文件中不一样,写注释时的分行,文档中会忽略。如果分档中要强制分行,必须加r,要强制分行并空一行,就加rr。下面是一个多行注释项的例子:
///$说明:
///这是第一行,
///这是第二行,在文档中不会强制换行。
/// 这是第二段,在文档中会强制换行,但 不会显示出来。
/// 这是第三段,在文档中会在前面插一个空行。
写完以后选中注释,注意不要选中///$那一行,点击MultiLineComment,就会按标准格式排版。保存前是什么样子的注释,以后调出来还是什么样子。
注释与函数声明(或类注释与类声明)之间不能有空行。
注释将存成XML文件,这样内容和显示可以完全分开。如果你对XML比较熟悉,可以定义自己的XSL文件来显示文档。不过,使用我写的文档显示工具也不错啊,虽然我对XML不熟悉,但是费了很多心血的。考虑到VC程序员比较习惯MSDN的风格,所以基本上是按照MSDN的格式来显示文档的,如果你喜欢漂亮一点,可以加一些配色或图片。
文档的显示其实只使用一个文件Doc.htm,具体内容完全是用脚本和xsl模板来实现的,所以IE的前进后退刷新之类的功能无法使用。
还有一个不错的功能:你也可以象MSDN一样,对函数进行分类。同一类的函数的声明要放在一起,并且在每类的第一个函数的注释上加分类这一项。用手工加上这一项
更多精彩
赞助商链接