C++ Logo

std-proposals

Advanced search

Re: [std-proposals] Standardizing Code Documentation

From: Jan Schultke <janschultke_at_[hidden]>
Date: Tue, 24 Jun 2025 14:59:11 +0200
> [[doc::brief("Allocates memory on the heap")]]
> [[doc::param(bytes, "The number of bytes to allocate")]]
> [[doc::return("A pointer to the heap or nullptr in case of an exception")]]

That seems a lot more verbose than

> @brief Allocates memory on the heap
> @param bytes The number of bytes to allocate
> @return A pointer to the heap or nullptr in case of an exception

.. so, no thanks, I don't want to write the above. If the goal is to
just provide documentation for C++ constructs, there doesn't seem to
be any technical reason why it couldn't live in a comment rather than
an attribute anyway.

Received on 2025-06-24 12:59:25