现在的位置: 首页 > 综合 > 正文

关于XML注释的一点随笔

2013年09月03日 ⁄ 综合 ⁄ 共 483字 ⁄ 字号 评论关闭

本文仅供初学者阅读,老手飘过(可以指点~~)

下面说一下我在用XML注释时的一些发现,或是经过。希望对你有用。

刚开始看到别人写的代码中都有这样的注释:

clip_image002

刚开始很不知道这是干嘛的,也不知道是如何出来的。知道是XML,但是不知道用来做什么的,在网上查了一下要如何才能有这种效果,不过没有找到。当时还想在学习一下XML之后再来写代码的。不过后来……

后来偶然间在写完一个类之后在类上添加该类的注释的时候按下了三个注释的符号(我用的vb.net)出现这样的状况:

clip_image004

于是乎,了解了原来这样就可以了。于是窃喜,并且在每个类以及类的方法上面都加了这样的标记并添了注释:

clip_image006

不过后来在调用这个借口时发现了一个问题:

clip_image008

原来这个XML注释的作用在此。

      总结说,也就是在一个类的方法上面加上这样的XML注释之后在调用这个类的方法时就可以得到相应的提示,并且是自己添加的提示。这样的话如果用在大的项目中,即便是拿到一个类库不是自己编的,只要有这样的说明一样可以很好的使用。相反你自己在编类库的时候也要想到有一天别人会拿来用,要如何才能让别人一看就知道你这个类的方法怎么使用,这就是一个很好的办法。

抱歉!评论已关闭.