一、C#文档注释
和Java一样,C#也有自己的一套文档注释规则,我们可以通过这套含有XML的特殊注释语法来为我们的代码书写注释。详细规则可查看百度文库:C#文档注释,在这里我写几个我自己常用的标签。
<summery>
:summery标签用于显示对该方法或类的详细描述,是最基本的注释标签。<param>
:param标签用于描述方法中的参数,需要在该标签的name属性中添加参数名作为属性值。<exception>
:异常标签用于记录该方法可能抛出的异常,并用它包围对该异常的描述(虽然不知道为什么显示不出来)。
剩余的因为用的少暂且先不记录了,如果后续有发现什么重要的就再更新吧。
二、NotImplementedException
如果在继承一个接口后使用VS自带的修补程序生成接口中的方法的话,VS就会自动在每个接口的方法中加上一句throw new NotImplementedException();
,大概意思就是说这个方法处于“未实现”的状态。严格意义上来讲,继承了接口的类有责任将其方法全部实现,那么问题就来了,如果我们最多只能用上该接口的一部分方法呢?剩下未使用的方法我们该如何实现?网络上有个例子,假设现在有个接口叫鸟,有飞行、进食、下蛋等方法,但当我用鸵鸟类继承鸟这个接口的时候,飞行方法就无法实现了,显然,我们不可能随便写一段代码返回一个无意义的值,那将会造成不必要的麻烦。甚至是带来危险的后果。为了解决这个方案,VS为我们添加了这句代码,使用一个异常抛出语句,既能够满足方法必须被实现的要求,又能警告使用者该方法尚未被实现,一举两得。
三、#region
与#endregion
#region
算是比较常用的一个预处理器指令了,它的效果和div很像,在代码量较大的时候可以用#region
将其包裹并折叠起来,起到增强代码可阅读性的作用。通常以#region
作为开头,并且必须以#endregion
作为结尾。