
# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 For example, the "modeline" feature of Vim which would change its handling of tabs while editing a source with this comment included near the top of the file: Many editors and IDEs will read specially formatted comments. Inserting such a /* Fall thru */ comment for human readers was a already a common convention, but in 2017 the gcc compiler began looking for these (or other indications of deliberate intent), and, if not found, emitting: "warning: this statement may fall through". * loop backwards through all elements returned by the server (they should be processed chronologically)*/ for ( i = ( numElementsReturned - 1 ) i >= 0 i - )
#Cx programmer constant code#
In this case it should explain the logic behind the code rather than the code itself. Planning and reviewing Ĭomments can be used as a form of pseudocode to outline intention prior to writing the actual code. There are many different ways of writing comments and many commentators offer conflicting advice. How best to make use of comments is subject to dispute different commentators have offered varied and sometimes opposing viewpoints. For example, Ada and Lua comments are line comments: they start with - and continue to the end of the line. Other languages support only one type of comment. For example, C++ has block comments delimited by /* and */ that can span multiple lines and line comments delimited by //. Some programming languages employ both block and line comments with different comment delimiters. Line comments either start with a comment delimiter and continue until the end of the line, or in some cases, start at a specific column (character line offset) in the source code, and continue until the end of the line. Some programming languages (such as MATLAB) allow block comments to be recursively nested inside one another, but others (such as Java) do not. This region is specified with a start delimiter and an end delimiter. īlock comments delimit a region of source code which may span multiple lines or a part of a single line. 6.1.6 Cisco IOS and IOS-XE configurationĬomments are generally formatted as either block comments (also called prologue comments or stream comments) or line comments (also called inline comments).
