`
holdbelief
  • 浏览: 707611 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

javadoc,在 Java 的注释上做文章

阅读更多

一篇介绍JavaDoc的很好的文章,因为word文档没有办法直接粘贴到这里,干脆用附件将word上传上来算了,还有我做的例子,可以用MyEclipse6.0直接打开。所有文件都在压缩包里面.

分享到:
评论

相关推荐

    javadoc 中文补丁

    曾经写过一篇文章《javadoc,在 Java 的注释上做文章》(http://outinn.myetang.com/book/javadoc/index.htm, http://outinn.myrice.com/book/javadoc/index.htm)。之后常有网友问起生成中文文档的问题: 问:...

    myeclipse生成javadoc并转成chm文档+jd2chm.exe+htmlhelp.exe

    通过在Java源代码中添加特定的注释,Javadoc可以解析这些注释并生成结构化的HTML文档,详细解释类、方法、接口等。这对于团队协作和维护大型项目非常有用,因为它提供了清晰的代码说明。 在MyEclipse中生成Javadoc...

    java 编码规范 javaAPI

    本篇文章将深入探讨Java编码规范以及如何有效地使用Java API。 一、Java编码规范 1. 命名规则: - 类名:采用驼峰式命名,每个单词首字母大写,如`MyClassName`。 - 变量名和方法名:也采用驼峰式命名,但第一个...

    java编程风格总结

    2. **文档注释**:使用Javadoc等工具可以自动生成API文档,因此在类、方法等定义前添加文档注释尤为重要。正确的文档注释格式不仅能提高代码质量,还能方便后续的文档生成工作。 3. **代码注释**:对于关键的业务...

    Java编码规范实用版

    本篇文章将深入探讨《Java编码规范实用版》中的关键知识点,帮助你提升代码质量。 1. **命名规范** - 类名:采用大驼峰式命名,首字母大写,如`MyClass`。 - 方法名:采用小驼峰式命名,首字母小写,如`myMethod`...

    java的详细规范(命名规范等一系列规范)

    本篇文章将详细讨论Java的命名规范和文件样式,这些都是编写高质量Java程序的基础。 首先,我们来看命名规范: 1. **包名(Package)**: 包名应由小写字母组成,通常使用公司或组织的反向域名,例如`...

    NIT-Pro初级软件工程师(Java)案例题_sample

    - **博客(Blog):** 使用特定软件在网络上发表个人文章的人。 - **日志(Post):** 简短且经常更新的文章,涵盖范围广泛,包括但不限于评论、新闻、日记、照片等。 - **栏目:** 用于组织日志的分类,便于用户...

    java 混淆工具,不可逆 jocky 也许是最好的了

    而Jocky与其它混淆编译器最大的不同之处在于:它是直接从源码上做文章,也就是说编译过程本身就是一个混淆过程。 1.3 Jocky是如何工作的? Jocky混淆编译器是在Sun JDK中提供的Java编译器(javac)的基础上完成的,...

    怎么样写好安全代码

    6. **避免冗余**:注释不应重复代码本身已经表达的信息,而是要解释为什么要这么做。 7. **注释掉困惑的代码**:如果某些代码难以理解,最好将其注释掉并重新编写更为清晰的代码。 #### 示例:Javadoc注释 ```java...

    如何写好shenlun

    可以利用自动化工具(如Java的Javadoc、Python的Sphinx等)生成文档。 7. **示例和案例**:提供实际的代码示例来说明如何使用特定的函数或组件,有助于读者快速上手。 8. **模块化思维**:将大的任务分解成小的可...

    简单学习Java API 设计实践

    清晰、一致的命名可以提高API的易用性,而详细的Javadoc注释可以帮助开发者理解API的功能和用法。API的设计还应当考虑可测试性,提供足够的公开接口供单元测试,同时限制私有和受保护成员的暴露,以保持实现细节的...

    joc eclipse plugin

    而Jocky与其它混淆编译器最大的不同之处在于:它是直接从源码上做文章,也就是说编译过程本身就是一个混淆过程。 1.3 Jocky是如何工作的? Jocky混淆编译器是在Sun JDK中提供的Java编译器(javac)的基础上完成的,...

    jocky 混肴编译rar包(ant和插件俩个版本)

    而Jocky与其它混淆编译器最大的不同之处在于:它是直接从源码上做文章,也就是说编译过程本身就是一个混淆过程。 1.3 Jocky是如何工作的? Jocky混淆编译器是在Sun JDK中提供的Java编译器(javac)的基础上完成的,...

Global site tag (gtag.js) - Google Analytics