java文档注释笔记

文档注释/**…*/

     需要有相关文档兑程序说明时,但若文档与代码分离,则每次改变代码后都要改变文档,很麻烦,Java解决方案是:将代码同文档相关联,为达到此目的,最简单的就是将关联的文档都置于同一个程序文件中,然而,为标出程序中包含的文档,还必须使用一种特殊的注释语法,另外还需要一个工具,用于提取这些注释,并按有价值的形式将其展现出来,注释语法用的就是/**…*/,而用于提取注释的工具叫做javadoc,该工具不仅提取由特殊注释标记指示的信息,也将毗邻注释的类名或方法名提取出来,注释文档能用来生成HTML格式的代码报告,所以注释文档必须写在类,域,构造函数,方法,定义之前,注释文档由两部分组成:描述和块标记。

     @符号起头则为块标记注释,常见的javadoc块标记注释语法如下:

     @author      对类的说明,标明开发该类模块的作者

     @version      对类的说明,标记该类模块的版本

     @see         对类,属性,方法的说明,参考转向,也就是相关主题

     @param       对方法的说明,对方法中某参数的说明

     @return       对方法的说明,对方法返回值的说明

     @exception    对方法的说明,对方法可能抛出的异常进行说明

Eclipse开发工具内部集成了javadoc,可生成HTML文档:

     法一:在程序所在项目列表中按右键选择:expert->Java->javadoc,进入javadoc generation对话框,选择保存路径,单击finish即可。

     法二:在上方菜单内选择:file->export->Java->javadoc,后续步

如法一。

     法三:单击要生成的项目,然后在上方菜单栏内选择project->generate javadoc,后续步骤如法一

 

l Java自动注释功能:

在菜单栏内选择:window->perference->java->codestyle->code templates->comments;可开启自动注释功能,并对代码的通用模版进行编辑,以减轻注释工作量,注释类别包括files(新建文件时的注释),type(类的注释),filed(变量的注释),constructors(构造函数的注释),method(一般方法的注释)等。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
基于Springboot+Vue的智慧养老服务管理系统源码+项目使用说明(优秀毕业设计).zip 该项目属于个人毕业设计,经导师的精心指导与严格评审获得高分通过的设计项目。主要针对计算机相关专业的教师、正在做毕设、课设的学生使用,也可作为项目实战演练,可直接作为课程设计、期末大作业、毕设等。 1.项目代码功能经验证ok,确保稳定可靠运行。欢迎下载使用!在使用过程中,如有问题或建议,请及时私信沟通。 2.主要针对各个计算机相关专业,包括计科、信息安全、数据科学与大数据技术、人工智能、通信、物联网等领域的在校学生、专业教师或企业员工使用。 3.项目具有丰富的拓展空间,不仅可作为入门进阶,也可直接作为毕设、课程设计、大作业、初期项目立项演示等用途。 4.当然也鼓励大家基于此进行二次开发。 5.期待你能在项目中找到乐趣和灵感,也欢迎你的分享和反馈! 介绍 随着人口老龄化趋势的加剧,老年人口比例不断增加,传统的养老服务模式已经难以满足现代老年人的多元化需求。因此,如何高效、精准地提供养老服务,成为了社会关注的焦点。信息化与智能化的发展为养老服务带来了新的机遇。智慧养老作为新兴的养老服务模式,正逐步改变传统的养老服务格局。 #### 安装教程 1. 运行环境准备mysql8+java8+npm14.16.1 2. 配置maven路径,加载依赖 3. 运行sql文件,确保application.yml的数据库名称和账号密码是数据库所在主机的账号密码 #### 使用说明 1. 登入 账号:admin 密码:admin 账号:user 密码:123456 2.运行流程 前端初始化指令: > npm install 前端运行指令(有两个端,一个是管理端,一个是用户端): > npm run serve #### 项目演示 + 普通用户 访问者可以在最顶端看到系统的导航栏,根据自己的需求点击需要去到的页面。用户可以单击“入院指南”,在入院指南界面的输入框中输入标题并进行搜索,就可以查看标题、发布时间、注意事项、发布人、封面等其他信息,在个人中心界面中,可以看见家属的账号、密码和性别等基本信息,还可以对这些信息进行更新操作。 ![GIF 2024-6-17 19-49-40](GIF 2024-6-17 19-49-40-1718630421956.gif) + 管理员 管理员单击家属管理,在家属管理页面中输入家属的各项信息后,在页面中进行查询、新增或删除家属信息等操作。管理员点击护工管理,在护工管理页面中输入护工的所有信息,然后在页面上可以点击详情来查看护工的详细情况,点击修改来修改护工的信息,点击删除来删除护工的信息。管理员单击房间资料管理,在这个页面中可以对房间资料的信息进行管理。管理员单击床位管理,可以查看房间号、楼房名称等各项信息,还可以点击修改来修改床位信息,点击删除来删除床位信息。管理员还可以对老人入住进行管理,在这个界面中可以查看像入住编号、老人年龄等老人入住的详细信息,可以在界面顶端输入具体信息来查找,还可以点击删除来进行删除操作。管理员单击外出报备管理,在外出报备管理界面中可以查看老人的外出报备情况。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值