Kotlin/Dokka中私有注解在模型中的可见性问题解析
在Kotlin项目文档生成工具Dokka的使用过程中,开发者可能会遇到一个关于注解可见性的特殊问题:当配置documentedVisibilities为PUBLIC和PROTECTED时,预期中私有(private)或内部(internal)可见性的注解类不应该出现在生成的文档模型中。然而实际情况是,虽然这些注解类本身确实没有作为DAnnotation出现在模型中,但它们在被其他公共类使用时,却仍然会以Annotations.Annotation的形式出现在那些公共类的注解列表中。
这个问题的典型表现可以通过以下代码示例来说明:
private annotation class PrivateAnnotation
@PrivateAnnotation
class PublicClass
在这个例子中,PrivateAnnotation本身不会出现在Dokka生成的文档模型中,这是符合预期的。但出乎意料的是,PublicClass的注解列表中却仍然包含PrivateAnnotation的引用。这种行为可能会导致文档使用者困惑,因为他们可能会看到一些本应隐藏的注解信息。
从技术实现角度来看,这个问题涉及到Dokka处理注解可见性的两个不同层面:
-
对于注解类本身的处理:Dokka正确地遵循了
documentedVisibilities的配置,过滤掉了私有和内部可见性的注解类,没有将它们作为DAnnotation包含在模型中。 -
对于注解使用的处理:Dokka在收集被注解元素的注解信息时,似乎没有应用相同的可见性过滤规则,导致这些私有注解的使用仍然被保留。
这个问题本质上是一个模型一致性问题。理想情况下,Dokka应该在整个文档生成流程中一致地应用可见性过滤规则。也就是说,如果一个注解因为其可见性被排除在模型之外,那么所有使用该注解的地方也应该相应地排除这些注解引用。
对于遇到这个问题的开发者来说,目前可以通过自定义处理来绕过这个问题。但长远来看,这需要在Dokka的核心逻辑中进行修复,确保可见性过滤在整个文档生成过程中得到一致的应用。
理解这个问题对于使用Dokka的Kotlin开发者来说非常重要,特别是在需要严格控制API文档中可见内容的场景下。开发者应该意识到,当前版本的Dokka在注解处理上可能存在这种不一致性,并在审查生成的文档时注意检查这类情况。
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C051
MiniMax-M2.1从多语言软件开发自动化到复杂多步骤办公流程执行,MiniMax-M2.1 助力开发者构建下一代自主应用——全程保持完全透明、可控且易于获取。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C01
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0127
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00