Topic: Standard symbol documentation through comments


Author: homerocda@gmail.com
Date: Sat, 6 May 2017 07:59:27 -0700 (PDT)
Raw View
------=_Part_2273_1743946761.1494082767032
Content-Type: multipart/alternative;
 boundary="----=_Part_2274_1345254522.1494082767033"

------=_Part_2274_1345254522.1494082767033
Content-Type: text/plain; charset=UTF-8

Almost every modern language now has some standard way of documenting
pieces of code. Java has javadoc, python has Docstrings, rust has doc
comments, etc. C++, like C, does not have a standard convention for
documenting code, although almost everyone uses Doxygen to document their
code. Qt, on the other hand, has a similar documentation format.

My question is, how hard would it be to define a "documentation comment" in
the Standard? Even if it's something simple like Go's rule that "Every
comment immediately before an identifier declaration is said identifier's
documentation"?

I've asked the same question on reddit, and some folks were really excited
with the idea of accessing said documentation through the proposed
metaprogramming facilities.

--
You received this message because you are subscribed to the Google Groups "ISO C++ Standard - Future Proposals" group.
To unsubscribe from this group and stop receiving emails from it, send an email to std-proposals+unsubscribe@isocpp.org.
To post to this group, send email to std-proposals@isocpp.org.
To view this discussion on the web visit https://groups.google.com/a/isocpp.org/d/msgid/std-proposals/7c191f53-7272-4deb-a664-ec43ca8993b3%40isocpp.org.

------=_Part_2274_1345254522.1494082767033
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">Almost every modern language now has some standard way of =
documenting pieces of code. Java has javadoc, python has Docstrings, rust h=
as doc comments, etc. C++, like C, does not have a standard convention for =
documenting code, although almost everyone uses Doxygen to document their c=
ode. Qt, on the other hand, has a similar documentation format.<div><br></d=
iv><div>My question is, how hard would it be to define a &quot;documentatio=
n comment&quot; in the Standard? Even if it&#39;s something simple like Go&=
#39;s rule that &quot;Every comment immediately before an identifier declar=
ation is said identifier&#39;s documentation&quot;?</div><div><br></div><di=
v>I&#39;ve asked the same question on reddit, and some folks were really ex=
cited with the idea of accessing said documentation through the proposed me=
taprogramming facilities.</div></div>

<p></p>

-- <br />
You received this message because you are subscribed to the Google Groups &=
quot;ISO C++ Standard - Future Proposals&quot; group.<br />
To unsubscribe from this group and stop receiving emails from it, send an e=
mail to <a href=3D"mailto:std-proposals+unsubscribe@isocpp.org">std-proposa=
ls+unsubscribe@isocpp.org</a>.<br />
To post to this group, send email to <a href=3D"mailto:std-proposals@isocpp=
..org">std-proposals@isocpp.org</a>.<br />
To view this discussion on the web visit <a href=3D"https://groups.google.c=
om/a/isocpp.org/d/msgid/std-proposals/7c191f53-7272-4deb-a664-ec43ca8993b3%=
40isocpp.org?utm_medium=3Demail&utm_source=3Dfooter">https://groups.google.=
com/a/isocpp.org/d/msgid/std-proposals/7c191f53-7272-4deb-a664-ec43ca8993b3=
%40isocpp.org</a>.<br />

------=_Part_2274_1345254522.1494082767033--

------=_Part_2273_1743946761.1494082767032--

.


Author: Thiago Macieira <thiago@macieira.org>
Date: Sat, 06 May 2017 08:04:26 -0700
Raw View
On Saturday, 6 May 2017 07:59:27 PDT homerocda@gmail.com wrote:
> My question is, how hard would it be to define a "documentation comment" in
> the Standard?

Very.

--
Thiago Macieira - thiago (AT) macieira.info - thiago (AT) kde.org
   Software Architect - Intel Open Source Technology Center

--
You received this message because you are subscribed to the Google Groups "ISO C++ Standard - Future Proposals" group.
To unsubscribe from this group and stop receiving emails from it, send an email to std-proposals+unsubscribe@isocpp.org.
To post to this group, send email to std-proposals@isocpp.org.
To view this discussion on the web visit https://groups.google.com/a/isocpp.org/d/msgid/std-proposals/10529266.Y0EZEJYNu1%40tjmaciei-mobl1.

.