当前位置:首页 > Java

java如何记笔记

2026-03-21 07:10:41Java

使用代码注释记录关键逻辑

在Java代码中直接使用单行(//)或多行注释(/* */)记录核心算法、复杂逻辑或待优化点。例如:

// 使用快速排序提升性能,时间复杂度O(n log n)
Arrays.sort(data);

/* 
 * 注意:此处需处理多线程并发问题
 * 待优化为AtomicInteger
 */
int counter = 0;

维护README与技术文档

创建项目级文档(Markdown格式)记录:

  • 项目结构说明
  • 模块依赖关系
  • 重要API的使用示例
  • 环境配置要求 示例片段:
    
    ## 核心模块
  • service/: 业务逻辑层
  • dao/: 数据库访问层 需先启动ConfigLoader初始化配置

利用Javadoc生成API文档

遵循Javadoc规范编写类和方法说明,可通过javadoc命令生成HTML文档:

/
 * 计算圆的面积
 * @param radius 半径值(需大于0)
 * @return 面积计算结果
 * @throws IllegalArgumentException 当半径不合法时抛出
 */
public double calculateCircleArea(double radius) {
    if(radius <= 0) throw new IllegalArgumentException();
    return Math.PI * radius * radius;
}

使用单元测试作为活文档

通过JUnit测试用例展示代码使用方式:

@Test
public void testCalculateCircleArea() {
    Calculator calc = new Calculator();
    assertEquals(3.14, calc.calculateCircleArea(1.0), 0.01);

    assertThrows(IllegalArgumentException.class, 
        () -> calc.calculateCircleArea(-1));
}

版本控制提交信息规范化

在Git等版本控制系统中提交时,采用语义化消息格式:

feat: 添加用户登录验证
fix: 修复空指针异常#123
docs: 更新数据库连接说明

使用IDE内置工具

利用IntelliJ IDEA等工具的:

  • 书签功能标记重要代码位置
  • TODO注释自动跟踪任务(// TODO: 需重构缓存机制
  • 本地历史记录查看代码变更

建立知识图谱

使用思维导图工具(如XMind)梳理:

  • 核心类关系图
  • 异常处理体系
  • 第三方库集成要点
  • 性能调优路径

日志记录关键操作

通过日志框架记录运行时信息,补充静态文档的不足:

java如何记笔记

Logger.info("用户{}执行订单创建,参数:{}", userId, JsonUtils.toJson(request));
Logger.debug("开始处理库存扣减,商品ID:{}", skuId);

标签: 笔记java
分享给朋友:

相关文章

如何查看java版本

如何查看java版本

查看 Java 版本的方法 通过命令行工具 打开终端(Windows 为命令提示符或 PowerShell,macOS/Linux 为 Terminal),输入以下命令并回车: java -ve…

java如何编程

java如何编程

Java编程基础 Java是一种面向对象的编程语言,广泛应用于企业级开发、移动应用(Android)等领域。以下是Java编程的核心步骤和示例。 环境搭建 安装JDK 从Oracle官网下载适合…

如何启用java

如何启用java

启用 Java 的方法 检查 Java 是否已安装 在命令行或终端输入 java -version,如果显示版本信息,说明 Java 已安装。若未安装,需从 Oracle 官网 或 OpenJDK 下…

java如何输入

java如何输入

使用 Scanner 类进行输入 Scanner 是 Java 中最常用的输入工具,位于 java.util 包中。它可以读取用户的键盘输入或文件内容。 import java.util.Scann…

java如何安装

java如何安装

安装Java的步骤 下载Java开发工具包(JDK) 访问Oracle官方网站或OpenJDK项目页面,选择适合操作系统的JDK版本进行下载。推荐下载最新稳定版本以确保兼容性和安全性。 运行安装程序…

java如何打开

java如何打开

安装Java开发环境 下载并安装Java Development Kit(JDK),可以从Oracle官网或OpenJDK获取。确保选择与操作系统匹配的版本(Windows、macOS或Linux)。…