argument-comment-lint
Isolated Dylint library for enforcing
Rust argument comments in the exact /*param=*/ shape.
It provides two lints:
argument_comment_mismatch(warnby default): validates that a present/*param=*/comment matches the resolved callee parameter name.uncommented_anonymous_literal_argument(allowby default): flags anonymous literal-like arguments such asNone,true,false, and numeric literals when they do not have a preceding/*param=*/comment.
String and char literals are exempt because they are often already self-descriptive at the callsite.
Behavior
Given:
fn create_openai_url(base_url: Option<String>, retry_count: usize) -> String {
let _ = (base_url, retry_count);
String::new()
}
This is accepted:
create_openai_url(/*base_url=*/ None, /*retry_count=*/ 3);
This is warned on by argument_comment_mismatch:
create_openai_url(/*api_base=*/ None, 3);
This is only warned on when uncommented_anonymous_literal_argument is enabled:
create_openai_url(None, 3);
Development
Install the required tooling once:
cargo install cargo-dylint dylint-link
rustup toolchain install nightly-2025-09-18 \
--component llvm-tools-preview \
--component rustc-dev \
--component rust-src
Run the lint crate tests:
cd tools/argument-comment-lint
cargo test
Run the lint against codex-rs from the repo root:
./tools/argument-comment-lint/run.sh -p codex-core
just argument-comment-lint -p codex-core
If no package selection is provided, run.sh defaults to checking the
codex-rs workspace with --workspace --no-deps.
Repo runs also promote uncommented_anonymous_literal_argument to an error by
default:
./tools/argument-comment-lint/run.sh -p codex-core
The wrapper does that by setting DYLINT_RUSTFLAGS, and it leaves an explicit
existing setting alone. To override that behavior for an ad hoc run:
DYLINT_RUSTFLAGS="-A uncommented_anonymous_literal_argument" \
./tools/argument-comment-lint/run.sh -p codex-core
To expand target coverage for an ad hoc run:
./tools/argument-comment-lint/run.sh -p codex-core -- --all-targets