Feature/docs codocs: 完善工具类与核心配置的 Javadoc 注释mment refactor by 2462440162ljl · Pull Request #590 · linlinjava/litemall · GitHub
Skip to content

Feature/docs codocs: 完善工具类与核心配置的 Javadoc 注释mment refactor - #590

Open
2462440162ljl wants to merge 9 commits into
linlinjava:masterfrom
2462440162ljl:feature/docs-comment-refactor
Open

2462440162ljl wants to merge 9 commits into
linlinjava:masterfrom
2462440162ljl:feature/docs-comment-refactor

Conversation

@2462440162ljl

Copy link
Copy Markdown

修改内容

本次 PR 旨在完善 litemall-core 和 litemall-db 模块的 Javadoc 注释,提升代码可读性与维护性。

具体修改:

1. 补充 Javadoc 标签

  • 为 ExpressProperties.java 等核心配置类添加 @author、@since 等 Javadoc 标签
  • 补充方法参数说明:@param、@return

2. 清理死代码/IDE 残留注释

  • 删除 TODO、FIXME 等 IDE 自动生成的无用注释
  • 清理被注释掉的旧代码片段

3. 重构低质注释

  • 修正语法错误和模糊表述
  • 使注释与代码逻辑保持一致

影响范围

  • litemall-core 模块
  • litemall-db 模块

提交记录

  • docs(core): 完善工具类与核心配置的 Javadoc 注释

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants