MCPcopy Index your code
hub / github.com/GuillaumeGomez/doc-comment

github.com/GuillaumeGomez/doc-comment @v0.3.4

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.3.4 ↗ · + Follow
1 symbols 1 edges 2 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

doc-comment

Write doc comments from macros.

Please note that calling macros in doc attribute was added in Rust 1.54 so unless you need to support older Rust versions, you don't need this crate and you can do the same thing with:

```rust,no_run

[cfg_attr(doctest, doc = include_str!("../README.md"))]

```

Usage example

// Of course, we need to import the `doc_comment` macro:
#[macro_use]
extern crate doc_comment;

// If you want to test examples in your README file.
doctest!("../README.md");

// If you want to test your README file ONLY on "cargo test":
#[cfg(doctest)]
doctest!("../README.md");

// If you want to document an item:
doc_comment!(concat!("fooo", "or not foo"), pub struct Foo {});

For more information, take a look at the documentation.

Core symbols most depended-on inside this repo

main
called by 0
build.rs

Shape

Function 1

Languages

Rust100%

Modules by API surface

build.rs1 symbols

For agents

$ claude mcp add doc-comment \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page