Skip to content

docs: fix Enhancer constructor javadoc @param list to match signatures - #3275

Merged
hengyunabc merged 1 commit into
alibaba:masterfrom
zh-hanlabs:docs/enhancer-ctor-javadoc-params
Oct 9, 2026
Merged

hengyunabc merged 1 commit into
alibaba:masterfrom
zh-hanlabs:docs/enhancer-ctor-javadoc-params

Conversation

@zh-hanlabs

Copy link
Copy Markdown
Contributor

改了什么

Enhancer 两个构造器的 javadoc 中记录的 @param adviceId、@param matchingClasses、@param affect 在构造器签名中并不存在,而实际参数 listener、classNameMatcher、classNameExcludeMatcher 没有被记录。本 PR 将两个 javadoc 块的 @param 列表修正为与真实签名一一对应(中文描述沿用原有注释的措辞风格),纯注释修改。

为什么改

构造器签名在演进过程中删除了 adviceId、matchingClasses、affect 等参数,但注释没有同步更新,会误导阅读源码的开发者和 IDE 的参数提示。

怎么检查的

  • 逐项核对两个 javadoc 块的 @param 与构造器签名一一对应;
  • 纯注释修改,无任何行为变化。

@hengyunabc
hengyunabc merged commit 5fe5f06 into alibaba:master Oct 9, 2026
1 check passed
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.

2 participants