【2023，学点儿新Java

您所在的位置：网站首页 › java文档注释 › 【2023，学点儿新Java

【2023，学点儿新Java

2023-07-04 20:19| 来源: 网络整理| 查看: 265

前情回顾：

社会实在是太大了，你觉得有很多竞争者，事实上又没有竞争者，你唯一的竞争者，就是你心里那个好逸恶劳的小孩。

🎯作者主页：追光者♂🔥

🌸个人简介： 💖[1] 计算机专业硕士研究生💖 🌟[2] 2022年度博客之星人工智能领域TOP4🌟 🏅[3] 阿里云社区特邀专家博主🏅 🏆[4] CSDN-人工智能领域优质创作者🏆 📝[5] 预期2023年10月份 · 准CSDN博客专家📝

无限进步，一起追光！！！

🍎感谢大家点赞👍 收藏⭐ 留言📝！！！

🌿任何一个大神级的Java程序员，或者说架构师/技术专家，无不具有丰富的编程经验，都是从0开始积累的，只不过，这一过程的“酸甜苦辣”，只有ta自己知道。本篇首先针对 java初学者常见的错误做了总结，然后介绍了Java程序结构的一些知识，最后从注释的角度来解释Java中的注释类型并给出如何通过命令行的方式执行得到Java特有的文档注释的网页信息。

本文目录 🍄零、补充（依然是关于 HelloWorld.java 案例）🍑0.1 Java初学者常会犯的拼写错误🍑0.2 编译、运行时路径有问题🍑0.3 初学者可能会犯的语法问题🍑0.4 针对字符编码问题（乱码问题）💦0.4.1 解决方案一💦0.4.2 解决方案二 🍑0.5 Java程序的结构和格式🍑0.6 Java程序的入口🍑0.7 Java中两种常见的输出语句与注意事项🍑0.8 Java中的源文件名与类名🍑0.9 其它的一些建议 🍄一、关于“注释”🍑1.1 如何程序中的 “注释” ？🍑1.2 Java中的注释类型🍑1.3 示例code、执行Java中的文档注释

🍄零、补充（依然是关于 HelloWorld.java 案例）

此处的补充，针对上两篇，即Java-07：第一个Java程序——HelloWorld 以及 Java-08：HelloWorld.java案例小结。

🍑0.1 Java初学者常会犯的拼写错误

请记住：Java 是一门严格区分大小写的编程语言。

即：单词拼写问题

正确：class 错误：Class正确：String 错误：string正确：System 错误：system正确：main 错误：mian

包括但不限于以上单词拼写错误。我记得，当初在开始学C语言时，有时候真的会将main写成mian，不知道各位有没有犯过此类错误？

此外，关于标点符号使用问题

不能用中文符号。英文半角的标点符号（正确）括号问题，记住：括号是成对出现的。

🍑0.2 编译、运行时路径有问题

其实，这里在上一篇中已经介绍过了。

举例1：

在这里插入图片描述

造成上面错误的原因可能有：

源文件名不存在或者写错当前路径错误后缀名隐藏问题（如何解决？请参阅上一篇文章）

举例2：

在这里插入图片描述

原因可能有：

类文件名写错，尤其文件名与类名不一致时，要小心！类文件不在当前路径下，或者不在classpath指定路径下。

🍑0.3 初学者可能会犯的语法问题

举例1：

在这里插入图片描述

再次强调：声明为public的类应与文件名一致，否则编译失败。

举例2：

在这里插入图片描述

编译失败，需要注意：错误出现的行数，再定位到源代码中指定位置改错。

🍑0.4 针对字符编码问题（乱码问题）

例如，当cmd命令行窗口的字符编码与.java源文件的字符编码不一致，应当如何解决？

在这里插入图片描述

💦0.4.1 解决方案一

在Notepad++等编辑器中，修改源文件的字符编码：在这里插入图片描述

在EditPlus中可以将Java源文件另存为 ANSI编码方式（中文操作系统下即为GBK字符集）在这里插入图片描述

💦0.4.2 解决方案二

不是特别常见。

使用javac命令式，可以指定源文件的字符编码。

具体示例格式如下：

javac -encoding utf-8 Review01.java 🍑0.5 Java程序的结构和格式

结构如下：

类{ 方法{ 语句; } }

格式：

（1）每一级缩进一个Tab键

（2）{}的左半部分在行尾，右半部分单独一行，与和它成对的"{"的行首对齐

🍑0.6 Java程序的入口

之前也讲过，Java程序的入口是main方法

public static void main(String[] args){ }

🍑0.7 Java中两种常见的输出语句与注意事项

1. 换行输出语句：输出内容，完毕后进行换行，格式如下： System.out.println(输出内容); 2. 直接输出语句：输出内容，完毕后不做任何处理，格式如下 System.out.print(输出内容);

注意事项：

换行输出语句，括号内可以什么都不写，只做换行处理

直接输出语句，括号内什么都不写的话，编译报错

🍑0.8 Java中的源文件名与类名

（1）源文件名是否必须与类名一致？public呢？

如果这个类不是public，那么源文件名可以和类名不一致。但是不便于代码维护。

如果这个类是public，那么要求源文件名必须与类名一致。否则编译报错。

这里建议大家，不管是否是public，都与源文件名保持一致，而且一个源文件尽量只写一个类，目的是为了好维护。

（2）一个源文件中是否可以有多个类？public呢？

一个源文件中可以有多个类，编译后会生成多个.class字节码文件。

但是一个源文件只能有一个public的类。

🍑0.9 其它的一些建议

注意缩进!

一定要有缩进。缩进就像人得体的衣着一样！

只要遇到{}就缩进，缩进的快捷键tab键。

必要的空格

变量类型、变量、赋值符号、变量值之间填充相应空格，更美观。比如： int num = 10;

🍄一、关于“注释” 🍑1.1 如何程序中的 “注释” ？

代码注释是程序员在编写代码时添加的文字，用于解释代码的实现细节，目的是更好地理解代码。注释旨在帮助其他开发人员更好地理解代码，使代码更易于维护和修改。

下面是一些常见的注释类型：

单行注释：用两个斜线表示，通常在代码行后面加上注释内容。

多行注释：用多个星号和斜线表示，通常用于注释较长的代码块。

文档注释：一种特殊的注释类型，通常说明函数或类的使用方法、参数和返回值等信息，可以用于生成API文档。

TODO注释：用于提示未来需要完成的工作，方便程序员在代码后期进行工作安排。

注释都有什么作用？

帮助读者快速理解代码的作用和实现细节。

方便代码维护：由于注释可以帮助读者理解代码，因此在代码维护时能够更快更准确地定位问题。

显示程序员的思路和决策：注释可以让其他程序员更了解程序员的思路和决策。

生成文档：文档注释可以用于生成API文档，方便其他开发人员了解如何使用函数或类。

显然，好的注释可以使代码更易于读写和维护，因此程序员应该养成良好的注释习惯。（实际开发中，程序员可以先将自己的思想通过注释整理出来，再用代码去体现。）

🍑1.2 Java中的注释类型单行注释： //注释文字

多行注释： /* 注释文字1 注释文字2 注释文字3 */

文档注释 (Java特有)： /** @author 指定java程序的作者 @version 指定源文件的版本 */

说明1：

对于单行和多行注释，被注释的文字，不会出现在字节码文件中，进而不会被JVM（java虚拟机）解释执行。多行注释里面不允许有多行注释嵌套。

下面有一个广为流传的段子：

A：嘿 //是什么意思啊？ B：嘿. A：呃我问你//是什么意思？ B：问吧. A：我刚才不是问了么？ B：啊？ A：你再看看记录... B：看完了. A：......所以//是啥？ B：所以什么？ A：你存心耍我呢吧？ B：没有啊你想问什么？ …… 不断循环之后，A一气之下和B绝交，自己苦学程序。 N年之后，A终于修成正果，回想起B，又把聊天记录翻出来看，这时，他突然发现B没有耍他…… 而他自己也不知道当年他问B的究竟是什么问题……

说明2：

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

操作方式，例如：

javadoc -d mydoc -author -version HelloWorld.java

在这里插入图片描述

🍑1.3 示例code、执行Java中的文档注释 //单行注释 /* 多行注释 */ /** 文档注释演示。这是我的第一个Java程序！^_^ @author CSDN@追光者♂ @version 1.0 */ public class Comment{ /** Java程序的入口 @param args main方法的命令参数 */ public static void main(String[] args){ System.out.println("hello"); } }

在这里插入图片描述

执行：

在这里插入图片描述

可顺便练习一下Java中特有的文档注释的操作：

这是未执行命令之前的目录：

在这里插入图片描述

开始执行，命令如下：（其中 xiexu_doc是要生成的目录名称）

javadoc -d xiexu_doc -author -version Comment.java

在这里插入图片描述

从而得到：附：点我下载生成的源xiexu_doc资源在这里插入图片描述

进入xiexu_doc查看：生成了不少了HTML文件

在这里插入图片描述

我们可双击进入index.html（即首页）查看：就可以看到程序中写的文档注释。

在这里插入图片描述

即我们可以通过 javadoc 解析出 java程序中的文档注释，生成以网页格式存在的关于当前类的相关介绍信息。

在这里插入图片描述

持续更新中！

分享干货知识！

有用的话，点个赞！关注我吧！

🍒 热门专栏推荐：

🥇Python&AI专栏：【Python从入门到人工智能】🥈前端专栏：【前端之梦~代码之美(H5+CSS3+JS.】🥉文献精读&项目专栏：【小小的项目 (实战+案例)】🍎C语言/C++专栏：【C语言、C++ 百宝书】(实例+解析)🌞问题解决专栏：【工具、技巧、解决办法】📝 加入Community 一起追光：追光者♂社区

持续创作优质好文ing…✍✍✍

记得一键三连哦！！！

求关注！求点赞！求个收藏啦！

在这里插入图片描述

【本文地址】

公司简介

联系我们