Code comments like #abc (shell, make), //abc (Java), ///abc / //!abc (Rust) are easier to read when a space separates the comment marker from the content:
# abc
// abc
/// abc
//! abc
That is, the author and the text editor should be prepared to toggle comments by automatically inserting (code -> comment) and automatically removing (comment -> code).
Code comments like
#abc
(shell, make),//abc
(Java),///abc
///!abc
(Rust) are easier to read when a space separates the comment marker from the content:That is, the author and the text editor should be prepared to toggle comments by automatically inserting (code -> comment) and automatically removing (comment -> code).
And for docstring multiline comments:
Skip applying this style to shebangs.