Adding # noqa to a line indicates that the linter (a program that automatically checks code quality) should not check this line. Any warnings that code may have generated will be ignored. That line may have something that “looks bad” to the linter, but the developer understands and intends it to be there for some … Read more
Sure, you can, just use # pip docs: A line that begins with # is treated as a comment and ignored. Whitespace followed by a # causes the # and the remainder of the line to be treated as a comment.
tl;dr: REM is the documented and supported way to embed comments in batch files. :: is essentially a blank label that can never be jumped to, whereas REM is an actual command that just does nothing. In neither case (at least on Windows 7) does the presence of redirection operators cause a problem. However, :: … Read more
In the VBA editor, go to View, Toolbars, Customise… or right click on the tool bar and select Customise… Under the Commands tab, select the Edit menu on the left. Then approximately two thirds of the way down there’s two icons, Comment Block and Uncomment Block. Drag and drop these onto your toolbar and then … Read more
I am particularly guilty of this, embedding non-constructive comments, code poetry and little jokes into most of my projects (although I usually have enough sense to remove anything directly offensive before releasing the code). Here’s one I’m particulary fond of, placed far, far down a poorly-designed ‘God Object’: /** * For the brave souls who … Read more
Use : ‘ to open and ‘ to close. For example: : ‘ This is a very neat comment in bash ‘
A double quote to the left of the text you want to comment. Example: ” this is how a comment looks like in ~/.vimrc To be clear: Do not include a closing double quote. (See comment from Arslan Ali below.)
This is how I do it. Essentially by using Bash’s backtick command substitution one can place these comments anywhere along a long command line even if it is split across lines. I have put the echo command in front of your example so that you can execute the example and see how it works: echo … Read more
This has recently been discussed on the Node.js mailing list. According to Isaac Schlueter who created npm: … the “//” key will never be used by npm for any purpose, and is reserved for comments … If you want to use a multiple line comment, you can use either an array, or multiple “//” keys. … Read more
Its all metadata for the Foobar module. The first one is the docstring of the module, that is already explained in Peter’s answer. How do I organize my modules (source files)? (Archive) The first line of each file shoud be #!/usr/bin/env python. This makes it possible to run the file as a script invoking the … Read more