Use documentation comments to describe the programing interface.
使用文档注释来描述程序接口。
This example shows how to add XML documentation comments to your code.
此示例演示如何在代码中添加XML文档注释。
Compile the code to generate an XML file containing the documentation comments.
编译此代码，以生成包含该文档注释的XML文件。
Add additional code that USES the type or member with the new XML documentation comments.
用新的XML文档注释添加其他使用该类型或成员的代码。
This is an alternative to placing documentation comments directly in your source code file.
这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。
So if you examine the documentation comments surrounding the method in Listing 4, you find the @ejb-transaction type="Required" tag.
所以如果检查Listing4 中的方法旁边的文档注释，您会发现 @ejb-transaction type="Required"标记。
Sandcastle - Produces MSDN style documentation by reflecting over the source assemblies and optionally integrating XML documentation comments.
more沙堡-生成的MSDN超过源组件和可选的集成XML文档注释反映风格文件。
With assessment documented, the business analyst can ask other team members to conduct a review so that they can add their own comments to the relevant documentation.
在记录评价过程之后，业务分析员就可以让其他的团队成员进行一项评审，这样他们就可以向相关的文献添加自己的评论了。
However, it also has the advantages of a text document, since each object in the model can include attributes like comments and documentation.
不过，它还具有文本文档的优势，因为模型中的每个对象都可以包括注释和文档之类的属性。
In this example you did not produce any documentation in the model: perhaps you should generate comments.
在这个例子中，您没有在模型中产生任何文档：或许您应该产生注释。
Even if you use an older API, or make choices that aren't all the rage, good comments and documentation will help you adapt your application as requirements and expectations change.
即使使用较老的API或者选择不那么时髦的东西，好的注释和文档也可以在需求和预期变化时帮助调整您的应用程序。
Save block comments for formal documentation and for commenting out.
块注释用于注释正式文档和无用代码。
In a hurry of typical day-to-day toil, it is so easy to change the code and miss to update the comments, documentation, diagrams and other secondary artifacts.
在每日的编程成为急就章时，总是会忘记更新注释、文档、图示或其他次等级的工件。
After creating the artifacts and requirements, Victor invites other team members to review the assessment documentation and add comments.
在创建工件和需求之后，Victor会邀请其他的团队成员评审评价文件并添加评论。
A good example (which is also given in MongoDB documentation) is blog posts and comments.
一个好的示例(可在MongoDB文档中找到)是博客文章和评论。
According to the documentation, StickyNotes allows two types of comments.
根据其文档所述，StickyNotes支持两类注释。
The comments in the content are taken directly from one of the Rampart examples; they appear to be the only documentation of this configuration.
内容中的注释是直接从rampart例中拿过来的；这似乎是这项配置的惟一文档。
Think of it as comments or documentation (although there are other ways to include documentation as well).
应将其视为注释或记录(尽管还存在其他包含记录的方法)。
Code list values can be described in the UML model in comments or documented elsewhere in the system documentation.
代码列表值可以在uml模型中用注释描述，也可以记录在系统文档的其他地方。
However, tests make much better documentation than comments.
然而，测试能够比注释提供更好的说明。
phpDocumentor generates manual-format documentation by reading it from DocBlocks -- special PHP comments.
phpDocumentor 通过读取 DocBlocks（特殊的PHP注释）来生成手册格式的文档。
With the method of documentation, this article reviews and comments the traditional theory on period training and super-compensation by scholars abroad in recent years.
采用文献法研究近年来国外训练学者对传统的运动训练周期理论和超量恢复原则的反思并进行了评论。
Optional parameters will be listed at the beginning of the output as comments. This is a convenient way of replacing copyright messages and other documentation.
任意参量在产品初将是列出的作为评论。这是替换版权消息和其他文献一个方便方式。
To complete the picture, however, you need a special comment syntax to mark special documentation, and a tool to extract those comments and put them in a useful form.
然而，为使一切都整齐划一，还必须使用一种特殊的注释语法，以便标记出特殊的文档；另外还需要一个工具，用于提取这些注释，并按有价值的形式将其展现出来。
To complete the picture, however, you need a special comment syntax to mark special documentation, and a tool to extract those comments and put them in a useful form.
然而，为使一切都整齐划一，还必须使用一种特殊的注释语法，以便标记出特殊的文档；另外还需要一个工具，用于提取这些注释，并按有价值的形式将其展现出来。
应用推荐