Skip to content

docs: enrich README feature documentation - #3

Open
Siborne wants to merge 1 commit into
openquartz:mainfrom
Siborne:docs/enrich-readme
Open

docs: enrich README feature documentation#3
Siborne wants to merge 1 commit into
openquartz:mainfrom
Siborne:docs/enrich-readme

Conversation

@Siborne

@Siborne Siborne commented Aug 12, 2026

Copy link
Copy Markdown

补充 README 功能文档:

  • 脱敏支持:详细说明 @EmailDataMask / @MobileDataMask / @IdCardDataMask
    的脱敏规则(表格 + 示例),并澄清脱敏仅影响输出展示、不影响比较逻辑
  • 新增「内置比较器」小节:DefaultDiffComparator、BigDecimalEffectiveDiffComparator
  • 新增「结构化 diff 结果」小节:diffResult / DiffResult / Diff API 用法
  • 新增「输出前缀与自定义样式」小节:prefix 与自定义 ToStringStyle
  • 新增「其他行为说明」:static/transient 排除、反射缓存、默认比较行为
  • 修正笔误:DiffUtil -> DiffUtils

仅文档改动,无代码变更。

- data mask: detailed table + examples for @EmailDataMask/@MobileDataMask/
  @IdCardDataMask, and clarify masking only affects output, not comparison
- add built-in comparator section (DefaultDiffComparator,
  BigDecimalEffectiveDiffComparator)
- add structured diff result section (diffResult / DiffResult / Diff API)
- add output prefix + custom ToStringStyle section
- add misc behavior notes (static/transient skipped, reflection cache)
- fix typo: DiffUtil -> DiffUtils
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.

1 participant