EditPlus的使用和注释与API文档等

简介: EditPlus的使用和注释与API文档等

注释与API文档等

1.java规范的三种注释方式:

单行注释://

多行注释:/* */

文档注释(java特有)😕** */

2.单行注释和多行注释的作用:

1.对所写的程序进行解释说明,增强可读性。方便自己,方便别人

2.调试所写的代码

3.特点:

1.单行注释和多行注释,注释了的内存不参与编译。

换句话上就是,编译以后生成的.class结尾的字节码文件中不包含注释掉的信息

2.注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档

3.多行注释不可以嵌套使用

4.Java API 文档:

API:application programming interface。习惯上:将语言提供的类库,都称为api。

API文档:针对于提供的类库如何使用,给的一个说明书。类似于《新华字典》

5.良好的编程风格

EditPlus的使用

1.开发工具说明:

2.EditPlus的使用:

相关文章
|
3月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
2月前
|
Java API 数据中心
百炼平台Java 集成API上传文档到数据中心并添加索引
本文主要演示阿里云百炼产品,如何通过API实现数据中心文档的上传和索引的添加。
|
3月前
|
安全 Java API
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
这篇文章介绍了Swagger,它是一组开源工具,围绕OpenAPI规范帮助设计、构建、记录和使用RESTAPI。文章主要讨论了Swagger的主要工具,包括SwaggerEditor、SwaggerUI、SwaggerCodegen等。然后介绍了如何在Nest框架中集成Swagger,展示了安装依赖、定义DTO和控制器等步骤,以及如何使用Swagger装饰器。文章最后总结说,集成Swagger文档可以自动生成和维护API文档,规范API标准化和一致性,但会增加开发者工作量,需要保持注释和装饰器的准确性。
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
|
3月前
|
开发框架 Java 测试技术
Spring Boot中的API文档生成
Spring Boot中的API文档生成
|
3月前
|
JSON Java API
Spring Boot中使用OpenAPI生成API文档
Spring Boot中使用OpenAPI生成API文档
|
4月前
|
自然语言处理 安全 API
触发邮件接口有哪些?邮件API文档
**触发邮件接口**如AokSend、Mailgun、Amazon SES、Postmark和Sendinblue是自动化企业通信的关键。这些接口在特定事件时自动发送邮件,提高效率和客户体验。例如,AokSend提供详细的API文档,支持事件触发、模板管理和多语言集成;Mailgun以灵活性著称;Amazon SES适合大规模发送;Postmark专注于事务邮件;Sendinblue则提供邮件、短信和营销自动化功能。每种服务都有示例代码展示如何使用API发送邮件。选择合适的接口能提升企业通信效率和客户满意度。
|
4月前
|
Java API Spring
Spring Boot中配置Swagger用于API文档
Spring Boot中配置Swagger用于API文档
|
4月前
|
API 开发工具 git
ShowDoc自动生成api接口文档
ShowDoc自动生成api接口文档
109 0
|
4月前
|
前端开发 Java API
Java中的API设计与文档生成最佳实践
Java中的API设计与文档生成最佳实践
|
4月前
|
XML 自然语言处理 API
个人微信开发api文档
个人微信开发api文档