C++ Logo

std-proposals

Advanced search

Re: [std-proposals] Standardizing doc comments

From: Thiago Macieira <thiago_at_[hidden]>
Date: Fri, 21 Mar 2025 09:56:09 -0700
On Thursday, 20 March 2025 23:59:33 Pacific Daylight Time Jan Schultke via Std-
Proposals wrote:
> Has there been any attempt to standardize doc comments for C++,
> similar to Javadoc
> (https://download.java.net/java/early_access/loom/docs/specs/javadoc/doc-com
> ment-spec.html)?
>
> Doxygen-style comments have been existing practice for a long time,
> and many tools support them to some extent. I could improve UX if we
> had a standard syntax and a set of standard tags for such comments.

We don't need something in the Standard for this, because the Standard won't
do anything about it. Unlike Java, there's no reference compiler with a
reference document generator.

But as you say, we have a de-facto standard. Most IDEs can highlight those
blocks properly, often parse them to display next to function uses to help
developers. So I think we have everything we need.

-- 
Thiago Macieira - thiago (AT) macieira.info - thiago (AT) kde.org
  Principal Engineer - Intel DCAI Platform & System Engineering

Received on 2025-03-21 16:56:14