很多教学用书中,代码片段都包括一些文本来解释代码在做什么。这种方法不仅对教学用书有用,对任何类型的编码都有用。理想情况下,会编写出完美的代码,完全适合任何未来的目的。尽管这是可能的,但是,几乎可以肯定,这些代码会由从没见过该代码、对上下文背景了解最少的人来操作。或者因为代码是很久以前写的,作者可能不记得做出了什么决策或要为什么要做出这些决策。因此,添加注释是很有用的,尤其是代码可能比较复杂或要实现特定的业务规则。

  内联注释放在代码体内。它们通常用来给这部分代码提供额外的详细信息。在重构时,它们也可能用于删除一些代码行;这些代码不希望运行,但也不希望完全删除,直到确信新代码像预期那样工作为止。 

  可以手工输入注释,也可以突出显示要注释的代码行,例如注释掉现有的代码,然后单击工具栏上的Add Comment按钮。

  还可以给方法添加注释。注意,智能感知功能会提供可能选择的项的信息。可以通过另一种注释给的方法提供同样的支持:XML注释。XML注释允许给方法添加额外的细节,基上是添加适用于整个方法的注释。   

  有几个标签,每个标签都在文档中起着不同的作用。 summary元素的内容显示在智能感知功能中,所以需要给潜在用户提供方法的足够信息,使他们可以确定它是否是他们需要的方法。因为代码被分离出来,以允许在多个领域使用,所以根据XML注释提供的任何额外支持都是有用的。param元素包含传入参数的描述,而 returns元素描述了它返回的内容,以及它在方法的上下文中的含义。

  当方法和它们所做的工作进一步远离请求该工作的代码时,注释就变得更重要。前面指出,把代码移到一个共享的区域会提高重用性。这种软件开发方法基于确定理解和组织代码的佳方法,称为面向对象编程。

关于TeamDoc软件:

TeamDoc是基于服务器/客户端架构的轻量级文件管理软件。TeamDoc将文件集中加密存储在您单位自己的服务器中,员工使用TeamDoc客户端访问服务器,从而获得与自己权限相关的权限:登入后与“我的电脑”界面类似,可以看到自己该看的文件,编辑自己能编辑的文档,对于能看到的文件,还可以细分文档权限,进而做到能看不能拷,能看不能截屏等功能,多种权限灵活设置,在线协同编辑、全文搜索、日志与版本追踪,快速构建企业文档库。告别假大空,我们提供值得您选择的、易用的、可用的文档管理软件。现在就访问TeamDoc首页

版权所有:南京网亚计算机有限公司,本文链接地址: 编写注释和文档