godot-rust项目中用户文档的废弃与实验性标记支持

在软件开发过程中，良好的文档注释对于代码维护和团队协作至关重要。godot-rust项目作为Godot引擎的Rust绑定库，其文档系统需要支持标记某些API为"废弃"或"实验性"状态的功能，这与GDScript中的@experimental和@deprecated标签功能类似。

文档标记的重要性

在API设计中，明确标识出哪些功能是实验性的或即将废弃的，这对使用者来说非常重要：

1. 废弃标记：告知用户该API将在未来版本中被移除，应该避免使用并迁移到替代方案
2. 实验性标记：表示该API可能不稳定，在后续版本中可能会有重大变更

实现方案探讨

在godot-rust项目中，有几种可能的实现方式：

Rust原生属性方案

可以直接使用Rust内置的#[deprecated]属性：

#[deprecated]
#[deprecated = "message"]
#[deprecated(since = "1.2.3", note = "message")]

优点：

• 与Rust生态系统一致
• 编译器会生成警告

局限性：

• 没有对应的实验性标记
• Rust的废弃标记会强制产生编译器警告，可能不符合所有场景需求

自定义文档注释语法

借鉴GDScript、Doxygen等工具的@keyword风格：

/// 常规文档内容
///
/// @deprecated 这个API将在下个版本移除
/// 请使用new_api()代替
///
/// @experimental 这个功能还在测试阶段
/// API可能会发生变化

优点：

• 灵活性高，可以添加详细说明
• 与Godot生态保持一致
• 支持多行说明文本

实现考虑：

• 需要解析文档注释中的特殊标记
• 在生成Godot文档时转换这些标记

技术实现建议

对于godot-rust项目，推荐采用自定义文档注释的方案，原因如下：

1. 一致性：与Godot引擎的GDScript文档风格保持一致，降低用户认知负担
2. 灵活性：可以添加详细的说明信息，而不仅仅是简单标记
3. 独立性：不强制产生Rust编译器警告，让开发者有更多控制权

实现时需要注意：

• 文档解析器需要识别@deprecated和@experimental标记
• 标记后的内容应作为整体处理，直到遇到下一个标记或文档结束
• 在生成的Godot文档中，这些标记应转换为相应的视觉提示

最佳实践示例

/// 提供旧式渲染功能
///
/// @deprecated 从4.2版本开始废弃
/// 请改用Renderer::new()和SceneRenderer
/// 旧API将在5.0版本中完全移除
///
/// 注意：在迁移过程中...
#[derive(GodotClass)]
pub struct LegacyRenderer {
    // ...
}

/// 实验性光线追踪功能
///
/// @experimental API尚未稳定
/// 性能表现可能会有较大波动
/// 建议仅在测试场景使用
#[godot_api]
impl MyExperimentalFeature {
    // ...
}

这种格式既保持了Rust文档注释的风格，又加入了Godot特有的标记系统，能够很好地满足项目需求。