`

包的注释内容-引用

华为编程HTML.netC 
阅读更多

引用说明：原文来自于http://topic.csdn.net/u/20101230/19/11839179-6dda-43a0-9bbf-c8d753908a13.html ，为了方便本人阅读，文本格式略有调整。

 

 

今天刚好看了**公司的ava编程规范，也是建一个package.html放在当前目录下。

3. 包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。
说明：在详细描述中应该说明这个包的作用以及在整个项目中的位置。
格式：
<html>
<body>
<p>一句话简述。
<p>详细描述。
<p>产品模块名称和版本
<br>公司版权信息
</body>
</html>

示例：
<html>
<body>
<P>为 WEBSMAP 提供通信类，上层业务使用本包的通信类与 SMP-B 进行通信。
<p>详细描述。。。。。。。。
<p>IIN V100R001 WEBSMAP
<br>(C) 版权所有 2000-2001 华为技术有限公司
</body>
</html>

分享到：
| 用Doxygen生成源代码文档-引用
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    注释、引用及其标注.doc

    【注释、引用及其标注】在学术写作中是至关重要的组成部分，主要涉及到如何正确地引用他人的观点、数据和研究成果，以及对特定内容进行解释和补充。本讲主要讲解注释和引用的基本概念、分类以及功能，以确保学术诚信...

    自定义注释的mybatis-generator-core-1.3.6.jar

    在上述配置中，我们可以看到一个`CustomCommentPlugin`插件的引用，这是实现自定义注释的关键。通过扩展MBG提供的插件接口，开发者可以定义自己的逻辑来添加特定的注释。例如，为每个字段添加数据库字段的描述作为...

    reactor-netty-http-1.0.11-API文档-中文版.zip

    赠送jar包：reactor-netty-http-1.0.11.jar； ... ... ... ... ...标签：projectreactor、netty、reactor、http、中文文档、jar包、java；...人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。

    VINS-Mono代码注释，仅供学习

    标题中的“VINS-Mono代码注释”意味着这是一个包含了VINS-Mono源代码及其详细解释的学习资源。这样的资料对于深入理解VINS-Mono的工作原理和算法细节至关重要。通过阅读和分析代码注释，SLAM算法工程师可以了解到...

    C++实验1-13，包含完整程序、注释、报告

    本资源为C++实验1-13，包含完整程序、注释、报告非常适合初学者学习、研究，具体如下： 实验1-熟悉Visual C++编程环境 实验2-利用函数编程 实验3-指针与引用的编程 实验4-类与对象的编程 实验5-构造函数与析构函数的...

    Python-神注释大全

    1. **幽默元素**：将幽默元素融入注释，可以减轻编码时的压力，如使用俏皮的语言、引用流行文化等。 2. **故事化注释**：通过构建一个小故事，将代码逻辑以叙述的方式展现，使阅读过程更有趣。 3. **视觉提示**：...

    Qt编写移除C++代码注释源码

    对于每行，我们需要检查是否以'/'开头，然后判断是否是注释或者路径、引用等特殊情况。如果是注释，我们就忽略它；如果不是，就将其保存到结果中。 在处理多行注释时，情况会复杂一些，因为它们可以嵌套在其他注释...

    PHP Document 代码注释规范

    - **文件注释**：位于文件顶部，通常用于描述整个文件的内容。 - **块注释**：位于函数、类、方法等定义之前，用于描述具体元素的功能和使用方法。 2. **编写块注释** 块注释必须以 `/**` 开头，后跟一个空行，...

    javadoc 生成注释 和 检查注释的文档

    `newJavaFile.xml` 文件可能包含新创建Java文件时的默认模板，这可能包括类、接口或枚举的JavaDoc注释，以及一些标准的版权声明或包声明。 生成JavaDoc的过程通常涉及以下步骤： 1. **配置**：设置JavaDoc选项，如...

    jjwt-api-0.11.2-API文档-中文版.zip

    赠送jar包：jjwt-api-0.11.2.jar； 赠送原API文档：jjwt-api-0.11.2-javadoc.jar； 赠送源代码：jjwt-api-0.11.2-sources.jar；...人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。

    Jar包自动生成代码 (带自定义注释)

    如果需要更复杂的自定义注释，可以编写自己的`CommentGenerator`实现类，并在配置文件中引用。 3. **执行MBG**： 有了配置文件后，可以通过Java API或者Maven插件来执行MBG。例如，使用Maven，可以在`pom.xml`中...

    java源码包---java 源码 大量 实例

    6个目标文件，EJB来模拟银行ATM机的流程及操作：获取系统属性，初始化JNDI，取得Home对象的引用，创建EJB对象，并将当前的计数器初始化，调用每一个EJB对象的count()方法，保证Bean正常被激活和钝化，EJB对象是用...

    Libsvm-2.5 程序代码注释

    【标签】"SVM实现" 标签表明这个压缩包的核心内容是关于SVM的实现，SVM是一种监督学习算法，通过构造最大边距超平面来对数据进行分类。它在处理高维空间问题和小样本数据集时表现出色，常用于文本分类、图像识别等...

    javadoc标准注释文档

    3. **注释内容**： - 注释应简洁明了，描述清楚功能、使用方式和注意事项。 - 避免过于冗长，保持代码的清晰度。 - 对于复杂的逻辑，可以用多个段落进行解释。 4. **生成文档**： - 使用`javadoc`命令行工具，...

    五子棋vb源代码-完整注释-绝对原创

    工程1.vbp是VB项目文件，它包含了项目的整体配置信息，如窗口大小、控件位置、引用库等。打开此文件，我们可以看到程序的主模块和窗体定义。Form1.frm则是游戏界面的主要设计文件，包含了用户界面的所有元素，如按钮...

    imageio-core-3.1.1-API文档-中文版.zip

    赠送jar包：imageio-core-3.1.1.jar； 赠送原API文档：imageio-core-3.1.1-javadoc.jar； 赠送源代码：imageio-core-3.1.1-sources.jar；...人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。

    java中的注释规范

    - `@see` 引用相关类、属性或方法 - `@param` 描述方法参数 - `@return` 描述方法返回值 - `@exception` 描述方法可能抛出的异常 5. **源文件注释**：源文件顶部应包含文件的元信息，如文件名、版本号、作者、...

    eclipse代码/注释规范

    - 使用`@see`、`@link`标签引用其他类或方法，增强文档关联性。 5. **命名约定**： - 类名使用驼峰式命名，首字母大写，如`ClassName`。 - 变量和方法名使用小驼峰式命名，首字母小写，如`variableName`、`...

Magicbox
Global site tag (gtag.js) - Google Analytics