Skip to content

Commit f35c4ad

Browse files
authored
Remove rules about DartDoc comments in the language specification (#4511)
Remove the rules about DartDoc comments in the language specification. This topic is now completely handled by each tool team for tools that process Dart comments in any way.
1 parent d0cc573 commit f35c4ad

File tree

1 file changed

+7
-28
lines changed

1 file changed

+7
-28
lines changed

specification/dartLangSpec.tex

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@
4141
% version of the language which will actually be specified by the next stable
4242
% release of this document.
4343
%
44+
% Sep 2025
45+
% - Remove the rules about DartDoc comments. This topic is now handled by each
46+
% of the tools that process those comments in any way.
47+
%
4448
% Jul 2025
4549
% - Clarify that operator `[]` and `[]=` are included in the `void` allowlist
4650
% rule about formal parameters of type `void`, and so are setters.
@@ -23406,40 +23410,15 @@ \subsubsection{Comments}
2340623410
Dart supports both single-line and multi-line comments.
2340723411
A \Index{single line comment} begins with the token \code{//}.
2340823412
Everything between \code{//} and the end of line
23409-
must be ignored by the Dart compiler
23410-
unless the comment is a documentation comment.
23413+
must be ignored by the Dart compiler.
2341123414

2341223415
\LMHash{}%
2341323416
A \Index{multi-line comment} begins with the token \code{/*}
2341423417
and ends with the token \code{*/}.
23415-
Everything between \code{/}* and \code{*}/
23416-
must be ignored by the Dart compiler
23417-
unless the comment is a documentation comment.
23418+
Everything between \code{/*} and \code{*/}
23419+
must be ignored by the Dart compiler.
2341823420
Comments may nest.
2341923421

23420-
\LMHash{}%
23421-
\IndexCustom{Documentation comments}{documentation comments}
23422-
are comments that begin with the tokens \code{///} or \code{/**}.
23423-
Documentation comments are intended to be processed by
23424-
a tool that produces human readable documentation.
23425-
23426-
\LMHash{}%
23427-
The current scope for a documentation comment immediately preceding
23428-
the declaration of a class $C$ is the
23429-
\IndexCustom{body scope}{scope!for statement body}
23430-
of $C$.
23431-
23432-
\LMHash{}%
23433-
The current scope for a documentation comment immediately preceding
23434-
the declaration of a non-redirecting generative constructor $k$
23435-
with initializing formals is the formal parameter initializer scope of $k$
23436-
(\ref{generativeConstructors}).
23437-
23438-
\LMHash{}%
23439-
Otherwise, the current scope for a documentation comment immediately preceding
23440-
the declaration of a function $f$ is the formal parameter scope of $f$
23441-
(\ref{formalParameters}).
23442-
2344323422

2344423423
\subsection{Operator Precedence}
2344523424
\LMLabel{operatorPrecedence}

0 commit comments

Comments
 (0)