016_JAVA基础语法_文档标记

发布时间:2022-06-20 发布网站:脚本宝典
脚本宝典收集整理的这篇文章主要介绍了016_JAVA基础语法_文档标记脚本宝典觉得挺不错的,现在分享给大家,也给大家做个参考。

文档标记用于包/类/方法javadoc注释的第三段。

常见标签

  1. @author

    • 用于指明作者,可附加邮箱或超链接

    • 有多少个作者就要用多少个该标签

    • 有时留的是组织名或邮箱

    • 不知道作者是谁时,就写 @author unascribed

    • 016_JAVA基础语法_文档标记

  2. @version 用于指明当前版本号

  3. @since

    • 用于指明最早出现在哪个版本

    • 也可填版本号或日期

    • 也可填可运行的JDK版本

  4. @param

    • 说明方法的参数

    • 先接参数名,再接参数描述,有几个参数就用几个该标签

      016_JAVA基础语法_文档标记

  5. @code

    • 将一些关键字或代码解析成代码样式(类似英文论文中对变量使用斜体)

    • 以下必须使用该标签:Java keywords、package names、class names、method names、interface names、filed names、argument names、code examps。

      016_JAVA基础语法_文档标记

  6. @return

    • 用于说明return的内容

    • 方法有返回值时必须包括该标签

      016_JAVA基础语法_文档标记

  7. @throws、@exception

    • 描述何时抛出异常

    • @throws、@exception是一模一样的

      016_JAVA基础语法_文档标记

所有图片来源:https://www.cnblogs.com/linj7/p/14339381.html

脚本宝典总结

以上是脚本宝典为你收集整理的016_JAVA基础语法_文档标记全部内容,希望文章能够帮你解决016_JAVA基础语法_文档标记所遇到的问题。

如果觉得脚本宝典网站内容还不错,欢迎将脚本宝典推荐好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。
标签: