#文档 #集群 # #字符串表示 #文件路径 #过程宏

doc-chunks

将文档注释和开发注释作为连贯视图的集群

6个版本

0.1.0 2024年4月24日
0.0.6 2024年1月5日
0.0.5 2022年11月23日
0.0.4 2022年9月15日
0.0.1 2022年5月25日

#333 in 过程宏

Download history 215/week @ 2024-04-17 483/week @ 2024-04-24 200/week @ 2024-05-01 240/week @ 2024-05-08 280/week @ 2024-05-15 251/week @ 2024-05-22 240/week @ 2024-05-29 259/week @ 2024-06-05 231/week @ 2024-06-12 374/week @ 2024-06-19 283/week @ 2024-06-26 289/week @ 2024-07-03 426/week @ 2024-07-10 402/week @ 2024-07-17 301/week @ 2024-07-24 157/week @ 2024-07-31

1,320 每月下载
cargo-spellcheck 中使用

MIT/Apache

160KB
3.5K SLoC

doc-chunks

提取集群文档行,并使用基于span的映射提供带有span和commonmark感知覆盖的overlay。


lib.rs:

文档块

Documentation 是一个或多个文档的表示。

literal 是由 proc_macro2ra_ap_syntax crate 提供的标记,然后通过使用 TrimmedLiteralCluster 转换为 CheckableChunk(通常只称为 chunk)。

CheckableChunk 可以由多个片段组成,其中每个片段可以跨越多行,但每个片段都覆盖了原始内容中的连续 Span。每个片段也与 CheckableChunk 内部字符串表示有直接映射。

Documentation 为每个文件路径存储一个或多个 CheckableChunks

依赖

~9–21MB
~254K SLoC