NopSCADlib icon indicating copy to clipboard operation
NopSCADlib copied to clipboard

Published 20 hours ago • verified publisher icon nophead

[Feature Request] Add support for c-style comments for documentation

Open martinbudden opened this issue 4 years ago • 2 comments

That is allow /*! ... */ comments, so

/*!
blurb
blurb
blurb
*/

could be used as well as

//!blurb
//!blurb
//!blurb

This would make editing documentation much easier.

martinbudden avatar Nov 22 '20 12:11 martinbudden

Problem is the simple parsing code is structured around processing one line at a time. It would need to maintain state between lines and get more complicated.

nophead avatar Nov 27 '20 18:11 nophead

Agreed it would be slightly more complicated. But the state is a simple one - either you are in a comment or you are not. It would be perfectly fine to force a quite if the user started to nest comments or anything vaguely complicated.

I think it's worth it - this would really make a difference when writing assembly instructions.

martinbudden avatar Dec 13 '20 09:12 martinbudden