zufuliu
Priority comments
When commenting code, you can get a whole mass of comments none of which stand out visually from each other. However some comments are priority visual ones that you want to stand out, for example they might be a sectional title to a block of code that follows. It would be very handy to have an extra comment colourisation the user can set, and a way for the user to designate how it is triggered, for example a sequence of characters immediately after the comment symbols. For example, a user might want to trigger it with --- and then a comment section title like
// --- CALCULATE TIME ---
/* --- CALCULATE TIME --- */
will be made some accentuated colour that stands out (the end --- there is redundant to the triggering)
I realise there is /// that can be used although that has a different documentation purpose.
David
I thought I might add here a screenshot to show how it looks when one abuses the /// to achieve this goal, showing how very useful headers are for readability; but it's ideal to use something other than ///
I was thinking there might be some benefit in having more than 1 custom comment style so that the code can have colourised major and minor headings, useful in longer code, and be used for other purposes, rather than just the 1. I think the 'trigger' characters should be exact and include any initial spaces so people could use //1 for heading style 1, //2 for heading style 2, //t might be for todos etc, and due to exactness // 1 would not trigger the style //1 etc. I'm not sure how many custom trigger slots would be the ideal but I think we would find many creative ways to use them.
Needs online documents, examples or sample projects for // --- xxx --- and /* --- xxx --- */ comment markers.
