rustdoc-stripper

rustdoc-stripper 是一个用于从您的代码中移除 rustdoc 注释并将其保存到 comments.cmts 文件（如果需要重新生成它们）的工具。

选项

rustdoc-stripper 可用的选项有

• -h | --help : 显示此帮助信息
• -s | --strip : 从当前文件夹中删除文件并创建一个包含 rustdoc 信息的文件（默认为 comments.cmts）
• -g | --regenerate : 从读取 rustdoc 信息文件（默认为 comments.cmts）重新创建包含 rustdoc 注释的文件
• -n | --no-file-output : 直接在 stdout 上显示 rustdoc 信息
• -i | --ignore [filename]: 忽略指定的文件，可以重复使用，仅在剥离文件时使用，否则忽略
• -d | --dir [directory] : 指定要处理的目录路径，可选
• -v | --verbose : 激活详细模式
• -f | --force : 移除确认请求
• -m | --ignore-macros : 忽略层次结构中的宏（因此只有带有文档注释的宏将出现在注释文件中）
• -o | --comment-file : 指定要保存 rustdoc 信息的文件

默认情况下，rustdoc 会以 -s 选项运行

./rustdoc-stripper -s

重要提示：只有以 '.rs' 结尾的文件才会被剥离/重新生成。

忽略文档注释

您可以通过在注释前添加 // rustdoc-stripper-ignore-next 来防止文档注释被剥离。

您可以使用 // rustdoc-stripper-ignore-next-stop 标记忽略块的末尾。

示例

// rustdoc-stripper-ignore-next
/// existing comment
// rustdoc-stripper-ignore-next-stop
/// This part will be removed when running rustdoc-stripper!
pub unsafe fn new() -> Foo {}