CodeSOD:公私合作伙伴关系 笔记

CodeSOD:公私合作伙伴关系

一名开发者在 API 的并发处理代码中发现了一处不一致。某状态属性的注释声明其应为私有,以防止误用;然而,该属性的定义却将其声明为 public。这一 public 定义允许外部调用者修改该状态,与注释所表达的意图相悖。作者指出,期望 API 用户阅读文档并遵守对 public 方法所建议的隐私性,这种情形颇具讽刺意味。此类不匹配在并发 API 中尤为令人担忧,误用的可能性及其可能引发的混乱被着重强调。尽管存在风险,代码仍保持公开可访问,仅靠注释作为警示。这凸显了一个常见的疏忽:文档与实现出现偏离。