+- MISRA Discussion Forums (https://forum.misra.org.uk)
+-- Forum: MISRA C (https://forum.misra.org.uk/forumdisplay.php?fid=4)
+--- Forum: MISRA C:2012 and MISRA C:2023 guidelines (https://forum.misra.org.uk/forumdisplay.php?fid=21)
+---- Forum: 8.3 Comments (https://forum.misra.org.uk/forumdisplay.php?fid=158)
+---- Thread: Rule 3.1 - Hyperlinks in comments? (/showthread.php?tid=1271)
Rule 3.1 - Hyperlinks in comments? - Andrew Banks - 02-09-2016
Cross-post from the MISRA C/C++ LinkedIn group
Quote:Is there any chance MISRA could alter Rule 3.1 to allow common hyperlinks in C comments such that a Deviation isn't required:
Code:/*
* See https://somewhere.over.the.rainbow/way/up/high.htm
*/
I use direct references to RFCs in source files that allow clicking in Visual Studio to open up a browser at the relevant spec. MISRA sees this as evil. If https: or http: occurs before //, then there isn't much confusion about commenting...
The (perfectly sound) Rationale for the Rule is to detect missing */ comment terminators.
There is already an Exception to permit // within a */ comment... so a further Exception to permit hyperlinks of the form http://, https://, ftp:// or ftps:// (without requiring a Deviation) seems reasonable?
Re: Rule 3.1 - Hyperlinks in comments? - misra-c - 23-09-2016
C90 and C99 strictly conforming compilers have well-defined behaviour for // within a /* comment. However many compilers are non strictly conforming and a variety of behaviour has been observed.
We suggest two methods for including hyperlinks within a comment.
- In C99, the use of // within a // comment is permitted in the Exception to this rule.
Code:// See https://somewhere.over.the.rainbow/way/up/high.htm
- Create a deviation/permit which permits the inclusion of // within a /* comment after checks have performed on the compiler that is used to confirm that such inclusion behaves as expected.