RTEMS big comment conventions
chrisj at rtems.org
Thu Oct 22 21:37:41 UTC 2020
On 23/10/20 3:13 am, Joel Sherrill wrote:
> On Thu, Oct 22, 2020 at 6:07 AM Andrew Butterfield
> <Andrew.Butterfield at scss.tcd.ie <mailto:Andrew.Butterfield at scss.tcd.ie>> wrote:
> Dear all,
> In the RTEMS Software Engineering manual, Sec 126.96.36.199
> it recommends excessively long comments be broken as follows:
> /* first line
> * second line
> * third, and in this case last line */
> I don't think that should be used. I don't know that we ever allowed that.
> Maybe that's a formatting mistake in the documentation. That part of the
> engineering guide was converted from the wiki to Sphinx by students.
I agree we should avoid this style.
More information about the devel