code-annotations

bearcove 的头像作者 bearcove

pikru的代码注释要求。在编写或从C代码移植Rust函数时使用。所有移植的函数都必须有 cref 注释。

📖 中文导读:pikru的代码注释要求。在编写或从C代码移植Rust函数时使用。所有移植的函数都必须有 cref 注释。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: code-annotations description: Code annotation requirements for pikru. Use when writing or porting Rust functions from C code. All ported functions must have cref comments.

Code Annotations

All Rust functions ported from C must be annotated with a cref comment:

// cref: c_function_name
fn rust_function() { ... }

Purpose

The // cref: comments create a traceable link between the Rust implementation and the original C function it was ported from. This helps:

  • Future maintainers understand the origin of the code
  • Cross-reference behavior between C and Rust implementations
  • Debug discrepancies between the two implementations