大数据必学Java基础（八）：简单介绍API和注释

已于 2022-08-20 02:45:43 修改
阅读量873 收藏 10
点赞数 14
分类专栏： 大数据必学Java基础 文章标签： 大数据 java
于 2022-06-24 22:22:04 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiaoweite1/article/details/125452987
版权
本文介绍了Java中的API和注释，包括API的作用、理解方式，以及单行注释、多行注释和文档注释的用法。强调了注释在提高代码可读性和便于调试方面的重要性，同时提到了文档注释可以使用javadoc生成项目API。
摘要由CSDN通过智能技术生成

文章目录

简单介绍API和注释

一、API

二、注释

单行注释和多行注释

文档注释

简单介绍API和注释

一、API

  • JDK帮助文档
  • SUN公司为JDK工具包提供了一整套文档资料,我们习惯上称之为JDK文档。
  • JDK文档中提供了Java中的各种技术的详细资料,以及JDK中提供的各种类的帮助说明。
  • JDk文档是Java语言的完整说明,大多数书籍中的类的介绍都要参照它来完成,它是编程者经常查阅的资料
  • 如何理解API：就当做是一个“字典”，“使用手册”，API就相当于是一个电子的帮助文档，可以帮我们查看JDK提供的类的信息，平时查看的时候可结合百
了解本专栏 订阅专栏 解锁全文 超级会员免费看
Lansonli
关注
专栏目录
订阅专栏
关于代码的注释的几种方法
m0_51259350的博客
02-08 2万+
vs中常见的注释方法
java代码注释指南：三大注释解析与最佳实践
weixin_75202470的博客
08-05 1645
注释是代码的声音，让我们的代码在沉默中绽放光彩！
Python代码注释详解（0基础入门
2301_80239908的博客
12-28 2270
代码注释就是给一段代码加上说明，表明这段代码的作用或者实现的功能，方便别人阅读代码。看看上面这个图，问题来了，那个女孩是谁？张三？李四？王五？除了上帝谁也不知道**（上帝：我也不知道）**！！加上注释再来一遍：禽兽，放开小红，我小明愿意和她交换。大家就都明白了，原来这个女孩叫小红，这个 Gay 叫小明。1.方便代码阅读2.被注释的代码，程序不会执行。
注释---＞一个编写代码不容忽视的技能
wei7a7a7a的博客
05-06 377
为了方便程序的阅读，Java语言允许程序员在程序中写上一些说明性的文字，用来提高程序的可读性，这些文字性的说明就称为注释。 注释不会出现在字节码文件中，即Java编译器编译时会跳过注释语句。 在Java中根据注释的功能不同，主要分为单行注释、多行注释和文档注释。 单行注释 单行注释使用“//”开头，“//”后面的单行内容均为注释。 多行注释 多行注释以“/*”开头以“*/”结尾，在“/*”和“*/”之间的内容为注释，我们也可以使用多行注释作为行内注释。但是在使用时要注意，多行注释不能嵌套使用。 文档.
教你写好代码注释
热门推荐
ruanrunxue的博客
12-08 1万+
前言 相信大家都会遇到这种情况：一周前自己写的代码，现在再拿出来看，发现读不懂了，“ 这代码是我写的？？？”。这时候，代码注释就可以发挥它的作用了——提高晦涩难懂的代码的可读性；注释可以起到隐藏代码复杂细节的作用，比如接口注释可以帮助开发者在没有阅读代码的情况下快速了解该接口的功能和用法；如果写的好，注释还可以改善系统的设计。 既然注释这么多好处，为什么我们程序员还是不愿意写注释？ “代码都写不完...
Java基础：Java上的注释和伪代码
02-13
在学习Java时，理解和掌握注释以及伪代码是至关重要的，它们是编程过程中的辅助工具，帮助提高代码的可读性和设计效率。 ## 1. Java注释 注释在Java中扮演着解释代码功能的角色，它们不被编译器执行，但对人类阅读...
Java-EE:Java EE的注释和程序
05-18
4. **JPA（Java Persistence API）**：在处理数据库操作时，`@Entity`, `@Table`, `@Id`等注释用于声明实体类和其映射关系，简化了ORM（对象关系映射）的配置。 5. **CDI（Contexts and Dependency Injection）**：...
Java-Programming:JAVA概念与示例和注释
03-14
本资源包“Java-Programming:JAVA概念与示例和注释”专注于Java的核心概念和基础，旨在帮助初学者和有经验的开发者深入理解Java语言的关键要素。 1. **Java概念** - **类与对象**：Java是一种面向对象的语言，一切...
Java：Java 的注释用法
01-13
单行注释用于快速简单的注解，多行注释适合解释复杂的代码段，而文档注释则用于生成对外部可见的 API 文档，提高代码的可读性和可维护性。在编写代码时，应根据需要合理使用这些注释，使代码更易读、更易于维护。
代码注释规范整理
Y2567326540的博客
05-22 5501
转载自51CTO大佬yuke198907 原文章地址：https://blog.51cto.com/yuke198907/1300804（侵删） 版权这个很重要 程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本，并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。好的注释规范可以改善软件的可读性，可以让开发人员尽快而彻底地
如何写出好的代码注释
Or1gami_的博客
05-23 2614
代码注释（以下简称注释）是嵌入在代码中的解释性文本，它们一般不会被编译或执行，但可以提供给开发者一些有用的信息。不同编程语言的注释格式可能不同，本文使用C语言来介绍。// 这是一段注释/* 这也是一段注释 */实际项目中的注释根据其形式和作用的不同，大体可以分为以下四类。
前端：HTML、CSS、JavaScript 代码注释 / 注释与代码规范
最新发布
snowball的博客
06-25 5297
HTML注释是在HTML代码中添加说明和解释的一种方法，这些注释不会被浏览器渲染或显示在页面上，而是被浏览器忽略。使用单行注释或多行注释：对于较短的注释，可以使用单行注释；对于较长的注释或需要跨越多行的注释，应使用多行注释。使用有意义的注释：确保注释提供了有价值的信息，而不是简单的“TODO”或“此处需要修改”。结束来标记多行注释。位于被注释的代码附近：通常，注释应位于被注释的代码之前或之上，以便于阅读和理解。位于被注释的代码之前：通常，注释应位于被注释的代码之前，以便于阅读和理解。
代码注释
weixin_35755188的博客
01-02 960
代码注释是在程序代码中写入的文本，旨在解释代码的含义、用途或者提供其他的信息。注释不会被程序执行，主要是用来帮助程序员阅读和理解代码。在不同的编程语言中，注释的格式也不相同。例如，在 Python 中，单行注释用 # 开头，多行注释用三个单引号或者三个双引号开头和结尾。 例如： # 这是一个单行注释 ''' 这是一个多行注释 ''' """ 这也是一个多行注释 """ 注释不仅可以用来解释代...
Python代码开头注释信息设置
捣鼓Python的博客
08-16 2654
在看别人写的代码，是不是经常发现，代码开头都有一段炫酷的开头注释，看起来很整洁，并且能够有效的传递给读者基础信息。我们先来看看设置后的代码开头注释效果，如果看完过后，你也希望设置一个专属你自己的开头，请继续往下看。...
python中注释方法的使用
IT之一小佬的博客
01-15 1681
python中注释方法的使用
谈代码注释
方亮的专栏
04-01 1万+
只要写代码，就会遇到代码注释的问题。在不同的公司，不同的项目组，不同的项目中，可能会有不同的注释标准。有些标准让我们感觉很受益，有些则让我们感觉很反感。而对于没有明确标准的项目，我们往往会遇到“百花齐放，百家争鸣”般的注释。我无法给出一个明确的标准，只是在此探讨下：什么样的注释不应该写，什么地方需要写注释。（转载请指明出于breaksoftware的csdn博客） “不”的原则 ...
vscode代码注释和文件头部描述注释
知识点沉淀包括不限于前端
03-26 7644
代码注释 单行、多行、jsdoc注释 特殊标记注释 todo等 vscode注释快捷键 vscode注释插件
代码首的注释
whysnlc的专栏
01-28 671
在Unix系统中在代码首添加：#!/usr/local/bin/perl 在非Unix系统中通常上添加：#!perl
评论 8
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Lansonli

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值