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在注解处理上可能存在这种不一致性,并在审查生成的文档时注意检查这类情况。
HunyuanImage-3.0
HunyuanImage-3.0 统一多模态理解与生成,基于自回归框架,实现文本生成图像,性能媲美或超越领先闭源模型00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0370Hunyuan3D-Part
腾讯混元3D-Part00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++0102AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选









