c#如何为命名空间加注释?
我只知道给类给方法和给属性给字段加注释都是直接点出三根斜杠就会有,但是不知道为命名空间加注释的话,应该怎么去做...
我只知道给类给方法和给属性给字段加注释都是直接点出三根斜杠就会有,但是不知道为命名空间加注释的话,应该怎么去做
展开
2个回答
展开全部
C#中注释就一共有三种情况,你说的直接点出三个斜杠也是其中的一种,另外两种是点出两个斜杠,还有就是/*这里是注释*/,这样的形式.一共就这三种
一般的,我们给类与方法加注释的时候才用你说的写出三个斜杠的形式,给字段加注释一般都用两个斜杠的方法.
如果给命名空间加注释,应该可以使用这三种里面的任意一种形式.
你需要明白这三种注释之间他们的区别:
加上三个斜杠:这样你在别处调用这个类或方法(这个方法也包括set,get访问器的方法)的时候,可以直接看到你加上的注释,增强程序的可读性.而其它两种是做不到这种功能的.所以这种加注释的方法也有另外一个名,突然想不起来了,因为平时很少叫这个名.而且加上这种注释以后,后期可以自动的生成说明文档,这是这种注释的优点.加两个斜杠就是注释一行,
/*星号里面的全是注释*/这种方法可以注释多行.
给命名空间加注释,应该可以选择这三种里的任意一种,因为命名空间是用来区别那些重名的类的,把类进行封装,没多少太大的意义,所以你如果想加注释,选/*注释*/这种形式的的就可以了.
不过一般我们很少给命名空间加注释的,因为加上了也没太大的意义.
一般的,我们给类与方法加注释的时候才用你说的写出三个斜杠的形式,给字段加注释一般都用两个斜杠的方法.
如果给命名空间加注释,应该可以使用这三种里面的任意一种形式.
你需要明白这三种注释之间他们的区别:
加上三个斜杠:这样你在别处调用这个类或方法(这个方法也包括set,get访问器的方法)的时候,可以直接看到你加上的注释,增强程序的可读性.而其它两种是做不到这种功能的.所以这种加注释的方法也有另外一个名,突然想不起来了,因为平时很少叫这个名.而且加上这种注释以后,后期可以自动的生成说明文档,这是这种注释的优点.加两个斜杠就是注释一行,
/*星号里面的全是注释*/这种方法可以注释多行.
给命名空间加注释,应该可以选择这三种里的任意一种,因为命名空间是用来区别那些重名的类的,把类进行封装,没多少太大的意义,所以你如果想加注释,选/*注释*/这种形式的的就可以了.
不过一般我们很少给命名空间加注释的,因为加上了也没太大的意义.
推荐律师服务:
若未解决您的问题,请您详细描述您的问题,通过百度律临进行免费专业咨询