注释内容要求
数据结构与存储
数据结构选择注释：
在选择特定的数据结构（如哈希表、链表、树、图等）时，注释应解释该结构为何适合当前的应用场景，以及它如何帮助优化内存使用或提升性能。
数据持久化注释：
对于需要持久化到磁盘的数据，注释应描述数据的存储格式、文件结构、备份与恢复策略，以及如何处理数据一致性和完整性问题。
接口设计与兼容性
API文档注释：
对于公共接口（如函数、方法、类等），注释应详细描述接口的输入参数、输出参数、返回值类型、异常抛出情况以及接口的使用场景和限制。
版本兼容性注释：
在修改现有接口或数据结构时，注释应明确说明这些修改对旧版本客户端的兼容性影响，以及是否需要提供迁移路径或向后兼容的实现。
平台兼容性注释：
注释应说明数据库代码在不同操作系统、数据库管理系统或硬件平台上的兼容性情况，以及可能存在的兼容性问题及其解决方案。
代码可移植性注释：
为了提高代码的可移植性，注释中应描述迁移过程中的兼容性问题、迁移步骤和注意事项，应指出代码中与平台或系统相关的特定实现，并提供可能的替代方案或抽象层设计。
测试与验证
测试用例注释：
在测试用例中，注释应描述测试的目的、测试的环境设置、预期的结果以及如何通过该测试来验证代码的正确性和健壮性。
性能测试注释：
在性能测试相关的代码或配置中，注释应记录性能测试的场景、性能指标（如响应时间、吞吐量）、测试结果以及性能调优的过程和效果。
单元测试：
对于关键函数或模块，注释应指出对应的单元测试代码的位置和测试用例的覆盖范围。
集成测试：
在集成测试相关代码中，注释应描述测试场景、测试数据和预期结果，以确保各模块之间的协同工作正常。
测试覆盖说明：
注释可以提及单元测试或集成测试所覆盖的代码范围，以及测试的目的和预期结果。
测试失败处理：
在测试代码或测试说明中，注释可以指出如何处理测试失败的情况，包括记录日志、自动回滚或通知相关人员。
测试策略与框架：
如果项目采用了特定的测试策略或测试框架，注释可以简要介绍这些策略和框架的使用方法和优势。
