Comments

From Rosetta Code
Jump to: navigation, search
Task
Comments
You are encouraged to solve this task according to the task description, using any language you may know.

All ways to include text in a language source file that's completely ignored by the compiler or interpreter.

See Also:

Contents

[edit] 360 Assembly

 
* An asterisk in column one denotes a comment line
* Comments may also follow any syntactically complete instruction:
LA 1,0 Comment
NOP Comment (after a NOP instruction)
* Comments after instructions with omitted operands require a comma ","
END , Comment (without comma, "Comment" assumed an operand of "END")
 

[edit] 4D

`Comments in 4th Dimension begin with the accent character and extend to the end of the line.

[edit] 6502 Assembly

Note: syntax depends on the assembler software but use of a semicolon is fairly standard

          nop           ; comments begin with a semicolon

[edit] 8086 Assembly

Note: syntax depends on the assembler software but use of a semicolon is fairly standard

	MOV AX, 4C00h 		; go back to DOS
INT 21h ; BIOS interrupt 21 base 16

[edit] ACL2

Just like Common Lisp:

; Single line comment
#| Multi-line
comment |#

[edit] ActionScript

See Java

[edit] Ada

-- All Ada comments begin with "--" and extend to the end of the line

[edit] ALGOL 60

A comment in ALGOL 60 takes the place of a single instruction.

 
'COMMENT' this is a first comment;
'COMMENT'
****** this is a second comment ******
;
 

[edit] ALGOL 68

[edit] With Standard

Comments can be inserted in variety of ways:

Algol68 as typically published,

includes bold typeface.

Quote stropping,

like to Wiki markup.

Case stropping,

7-bit/ascii implementations.

Res stropping,

detecting reserved words.

Point stropping,

6-bits/byte implementations.

¢ The original way of adding your 2 cents worth to a program with the "cent" character ¢ ¢ TEXT ¢
co Style i comment co

comment text comment

'co' text 'co'

'comment' text 'comment'

CO text CO

COMMENT text COMMENT

co text co

comment text comment

.CO TEXT .CO

.COMMENT TEXT .COMMENT

# Style ii comment with the hash character # # TEXT #

Notes:

  • The # test # and ¢ text ¢ comment tends to be used for inline comments. And the COMMENT text COMMENT style tends to be used to comment out entire blocks.
  • The script algol68.vim can be used to highlight commented blocks while editing source code.

[edit] With Extensions

£ This is a hash/pound comment for a UK keyboard £

[edit] AmigaE

/* multiline comment
are like C ... */
-> this is a end of line comment

[edit] Asymptote

// double slash to newline

See programming introduction in the Asymptote manual.

When reading data files a comment character in them can be specified as comment="#" etc. See Files in the Asymptote manual.

[edit] AutoHotkey

Msgbox, comments demo ; end of line comment
/*
multiline comment1
multiline comment2
*/

For multi-line comments, the /* and */ must be on their own separate lines. Nothing else can be on the same line.

[edit] AutoIt

 
#cs
Everything between the cs and and the ce is commented.
Commented code is not used by the computer.
#ce

;individual lines after a semicolon are commented.
 

[edit] AWK

The hash symbol # start a comment; it ends at the end of line.

BEGIN { # this code does something
# do something
}

[edit] Babel

 
-- This is a line-comment
 
#
This is a block-comment
It goes until de-dent
 
dedent: 0x42 -- The comment block above is now closed
 

[edit] BASIC

Works with: Applesoft BASIC
Works with: GW-BASIC
Works with: ZX Spectrum Basic

The only truly standard method of marking a comment in BASIC is using the REM keyword. This dates back to (at least) the late 1970's, and should work with most BASICs available today:

100 REM Standard BASIC comments begin with "REM" (remark) and extend to the end of the line
110 PRINT "this is code": REM comment after statement
Works with: Applesoft BASIC

This may not be well known, but you may include text after the line number of GOTO and GOSUB statements. This is kind of a comment in absence of labels.

100  GOTO 200HERE                      
110  GOSUB 300THERE                    
120  GOTO 400THEOTHERPLACE             
130  GOTO 500MOM AND  POP              

Spaces are removed from non-keyword text. BASIC keywords can be used. List outputs spaces around keywords.

Works with: QuickBASIC version 4.5

Most BASICs also support alternate comment characters, commonly an apostrophe (single quote):

 'this is a comment
PRINT "this is code" 'comment after statement
Works with: DarkBASIC

Characters other than apostrophe are used in some BASICs. For example, DarkBASIC uses a back-tick character (`, a.k.a. grave accent):

`this is a comment
PRINT "this is code" `comment after statement
'this is NOT a comment!
Works with: FreeBASIC version 0.16 or later

In addition to single-line comments, a few BASICs support block comments. FreeBASIC was influenced by the C family's block comment characters:

/' This is a multi line comment.
Requires FreeBASIC 0.16 or later.
Last line of the comment block. '/

DIM a AS /' Comment in the middle of statement '/ Integer

[edit] Batch File

rem Single-line comment.

There is another (unsupported) option, using a double-colon ::. However, this has issues with some syntactic constructs and therefore may raise syntax errors.

:: Another option, though unsupported and known
:: to fail in some cases. Best avoided.

Since comment lines are skipped entirely by the parser multi-line comments aren't possible even with line continuation.

[edit] BBC BASIC

      REM This is a comment which is ignored by the compiler
*| This is a comment which is compiled but ignored at run time

[edit] bc

/* This is a comment. */
 
2 + /* Comment between tokens. */ 3
 
"This is a string, /* NOT a comment */."
 
/*
* A comment can have multiple lines. These asterisks in the middle
* of the comment are only for style. You must not nest a comment
* inside another comment; the first asterisk-slash ends the comment.
*/

Works with: GNU bc
Works with: OpenBSD bc
#!/usr/bin/bc
 
# This form of comment is an extension, not part of standard bc.
 
# Your program must not have a #! shebang line
# unless your bc supports this form of comment.
 
2 + 3 # It can be after a statement.
 
a = 1 # The newline is not part of the comment.
b = 2 # So this line is a different statement.


[edit] Befunge

Like Brainf***, all characters and whitespace which are not commands are ignored. Also, since the code/data-space is two-dimensional, comments can be placed anywhere that will be untouched by the instruction pointer and data access commands. Finally, in Funge-98, the ; instruction immediately skips to the next ; instruction, which allows to isolate comments from code.

Works with: Befunge version 93
& read a number 2+ add two .@ display result and exit
^- inline comments -^ <-^- other comments
Works with: Befunge version 98
&;read a number;2+;add two;.@;display result and exit;
^- inline comments -^ <-^- other comments
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;completely isolated comment block for the paranoid;
;(almost - you can still skip into it.)  ;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

[edit] Blast

# A hash symbol at the beginning of a line marks the line as a comment 
 

[edit] Bracmat

Bracmat uses curly braces as comment delimiters. Curly braces inside comments must be balanced. Comments are so much ignored when source code is read, that they do not reappear in listings created by the built-in lst$ function, an otherwise very useful function to autoindent your code.

[edit] Brainf***

This is a comment

Most ASCII characters may be used for comments; only the eight characters "+-<>[],." are Brainf*** commands. Extra care must be used when using punctuation, particularly the comma or period. These are I/O operators and are actually commands rather than comments, and are instead compiled into the program if used and may have to be "debugged" and removed if you forget this issue.

[edit] Brat

# Single line comment
 
#* Multi
Line
Comment *#

[edit] Brlcad

 
# Comments in mget scripts are prefixed with a hash symbol
ls # comments may appear at the end of a line
 

[edit] Burlesque

Burlesque does NOT have comments. However, you can comment code by pushing a string and popping it immediately.

 
"I'm sort of a comment"vv
 

Since strings are multi-line strings:

 
"I'm a
very long comment spanning
over several lines"vv
 

[edit] C

/* This is a comment. */
/* So is this
multiline comment.
*/

The comment starts at the /*, and ends at the */. A comment may be used between any tokens. It cannot be used inside tokens, that is, given the code

struct charisma {};
void f(char/* comment */isma) {}

the function takes an argument of type char, named isma, not an unnamed argument of type charisma.

Comments cannot be nested; that is, if you write

/* some comment /* trying to nest some other comment */ inside */

the comment ends at the first */, and inside */ is again interpreted as source code (almost certainly causing a compile error). Some compilers have the option to allow nested comments, but this is not a standard feature.

Conditional compilation also can be used to make the compiler ignore some text:

#if 0
While technically not a comment, this is also ignored by the compiler
#endif

The trick is that 0 is always false, therefore the text between #if 0 and #endif is never compiled. While this should never be used for actual comments, it's an easy way to comment out some code, especially because it doesn't interfere with normal (documentation) comments.

Conditional compile "comments" can be nested:

#ifdef UNDEFINED
This is not compiled.
#if 0
Nor is this.
#endif
And this still is not compiled.
#endif
Works with: ANSI

Even though the compiler doesn't see #if 0 text, the preprocessor does. Therefore some minimal rules still have to be followed. For example, the following code is not valid:

#if 0	 
This isn't valid.
#endif

That's because the preprocessor will interpret the apostrophe as beginning of a character constant, and will complain because that character constant isn't terminated with another apostrophe.

Note that the problem mentioned above cannot occur if there's valid code between the #if 0 and #endif.

Works with: C99
// C++ single-line comments were adopted in the C99 standard.

[edit] C++

See also C

Single line C++-style comments

// This is a comment

C++-style comments start with // and reach up to, but not including, the end of line (more exactly, up to the next unescaped newline). While formally, C++-style comments cannot be nested either, in practice they can:

// This is a valid comment // with a "nested" comment

That's because starting with the first // everything in the line is ignored, including the second //. The fact that the newline is not part of the comment is important for multi-line macro definitions. It means that in the code

#define FOO \
(macro text) // comment

(no more macro text)

the line (no more macro text) is not part of the macro definition. Also escaping the line break at the end of the comment with '\' doesn't help, because that would make the third line part of the comment instead. Comments inside macros therefore have to be C-style.

[edit] C#

//This is a comment.
//This is other comment.
 
/* This is a comment too. */
 
/* This is a
multi-line
comment */

[edit] Chapel

// single line
 
/* multi
line */

[edit] Chef

Comment Stew.
 
This is a comment.
The other comment is a loop, but you can name it anything (single word only).
You can also name ingredients as comments
This is pseudocode.
 
Ingredients.
Ingredient list
 
Method.
Methods.
SingleWordCommentOne the Ingredient.
Methods.
SingleWordCommentTwo until SingleWordCommentOned.
Methods.

[edit] Clean

Clean comments are similar to C++.

Start = /* This is a multi-
line comment */ 17 // This is a single-line comment

In contrast to C++ comments can be nested.

Start = /* This is a comment /* Nested comment */ still a comment */ 17

[edit] Clojure

Anything from a semicolon to the end of a line is a comment.

;; This is a comment
(defn foo []
123) ; also a comment

The (comment) macro will prevent a form from being evaluated, returning nil no matter what is contained in the comment. However the forms inside the comment form must be properly parseable (parentheses balanced, etc.) or an exception will be thrown.

(comment (println (foo)) "bar" :baz 123 (System/exit 0))  ;; does nothing, returns nil

Finally, the #_ reader macro will cause a form to be ignored by the reader. Unlike (comment), this does not return nil; the surrounding code is evaluated as though the ignored form isn't even there.

(+ 1 (comment "foo") 3)  ;; Throws an exception, because it tries to add nil to an integer
(+ 1 #_"foo" 3) ;; Returns 4

[edit] COBOL

[edit] Fixed format

      * an asterisk in 7th column comments the line out

A D in the 7th column indicates a debugging line which is treated like a comment unless a compiler flag is set.

      D    DISPLAY "Debug"

[edit] Free format

*> This comment syntax was defined (with free format code) in COBOL 2002.
Works with: OpenCOBOL

This indicates a debugging line like above, but if it is used in fixed format files, it must be in the 8th column or beyond.

>>D DISPLAY "Debug"

[edit] NOTE statement

Works with: OS/VS COBOL

This statement causes everything following it up to the next separator period to be treated as a comment. This statement was deleted in COBOL-74.

           NOTE this paragraph is
commented out and ignored
.

[edit] CoffeeScript

# one line comment
 
### multi
line
comment ###

[edit] ColdFusion

In tags:

As ColdFusion's grammar is based around HTML syntax, commenting is similar to HTML.
<!--- This is a comment. Nothing in this tag can be seen by the end user.
Note the three-or-greater dashes to open and close the tag. --->
<!-- This is an HTML comment. Any HTML between the opening and closing of the tag will be ignored, but any ColdFusion code will still run.
Note that in the popular FuseBox framework for ColdFusion, the circuit.xml files require that you use this style of comment. -->

In script:

/* This is a comment */
// This is also a comment

[edit] Common Lisp

Common Lisp provides line comments (;) and block comments (#|...|#).

Block comments can nest (#|...#|...|#...|#), unlike block comments in e.g. C.

In a common convention, header comments are prefaced with four semicolons, top-level (function level) comments use three, comments for sections of code use two, and margin comments use one.

;;;; This code implements the foo and bar functions
 
;;; The foo function calls bar on the first argument and multiplies the result by the second.
;;; The arguments are two integers
(defun foo (a b)
;; Call bar and multiply
(* (bar a) ; Calling bar
b))
 
;;; The bar function simply adds 3 to the argument
(defun bar (n)
(+ n 3))

However, comments should not be used for inline documentation, as most defining constructs permit a documentation string (which is then available at runtime).

(defun bar (n)
"Add 3 to the argument."
(+ n 3))
 
(defclass button (widget)
(label action)
(:documentation "This is a push-button widget."))

[edit] Component Pascal

 
(* Comments (* can nest *)
and they can span multiple lines.
*)
 

[edit] D

void main() {
// A single line comment.
 
/* This is a simple C-style comment that can't be nested.
Comments mostly work similar to C, newlines are irrelevant.
*/

 
/+ This is a nestable comment
/+ See?
+/

+/
 
/// Documentation single line comment.
 
/**
Simple C-style documentation comment.
*/

 
/++
Nestable documenttion comment.
+/

}

[edit] dc

There is no comment syntax in POSIX dc. The convention is to make a string on the stack and move it to an unused register; a no-op.

[Making and discarding a string acts like a comment] sz

GNU dc added the comment syntax of many other scripting languages.

# remainder of line is a comment

[edit] Deluge

Comments are only allowed in places such as "on load" scripts. You cannot put them in form or view definitions.

// single line comment

[edit] Delphi

See also Pascal

In addition to Pascal, Delphi also allows C++ style single line comments:

// single line comment

[edit] Déjà Vu

#this is a comment
!print "this is not a comment, obviously" #this is a comment as well

[edit] DWScript

(* This is a comment.
It may extend across multiple lines. *)

 
{ Alternatively curly braces
can be used. }

 
/* C-style multi-line comments
are supported */
 
// and single-line C++ style comments too

[edit] Dylan

// This is a comment
 
/*
This is a comment
that spans multiple
lines
*/

[edit] E

# This is a regular comment.
 
? "This is an Updoc comment, which
> is an executable example or test case."
.split(" ")
# value: ["This", "is", "an", "Updoc", "comment,", "which
# is", "an", "executable", "example", "or", "test", "case."]

All comments span to the end of the line; there are no paired-delimiter comment syntaxes. “#” begins a comment anywhere outside of quotes; “?” and “>” begin comments only if they are at the beginning of a line (except for whitespace), because those characters are also used for infix operators.

In Updoc, “?” indicates the beginning of a program fragment, “>” the continuation of one, and “#” begins the expected output from its evaluation; “??” indicates special directives.

[edit] ECL

Single-line comments must begin with //

// this is a one-line comment 

Block comments must be delimited with /* and */

 /* this is a block comment - the terminator can be on the same line
or any succeeding line – everything in between is ignored */

[edit] EGL

See Java

[edit] Ela

//single line comment
 
/*multiple line
comment*/

[edit] Elixir

Elixir does not have multiple line comments.

 
# single line comment
 

[edit] Emacs Lisp

A comment is started by ; and reaches to the end of the line.

; This is a comment

There are some coding conventions for ;; align to indentation, ;;; sections, etc,

http://www.gnu.org/software/emacs/manual/html_node/elisp/Comment-Tips.html

Another way to add comments is to use strings at places where the result of an expression is ignored, since they simply evaluate to themselves without any effect. Note that strings can be multi-line:

"This is effectively a comment,
if used at a place where the result is ignored"

Note that strings at the beginning of function definitions are interpreted as documentation strings for the function (i.e. Emacs will display them if asked for help about the function), e.g.

(defun subtract-second-from-first (x y)
"This function subtracts its second argument from its first argument."
(- y x))

Due to this, it's debatable if the string at that place can be considered as comment.

[edit] Erlang

% Erlang comments begin with "%" and extend to the end of the line.

[edit] Euphoria

Single line comment:

-- This is a comment


Multiline C-style comment:

/*
This is a comment
*/
Works with: Euphoria version 4.0.0

[edit] F#

F# accepts C++ type line comments and OCaml type block comments

// this comments to the end of the line
(* this comments a region
which can be multi-line *)

[edit] Factor

! Comments starts with "! "
#! Or with "#! "
! and last until the end of the line
 

[edit] Fancy

# Comments starts with "#"
# and last until the end of the line
 

[edit] Falcon

Falcon supports C-language style single line and block comments. A single line comment begins with two slashes (//) and ends at the end of the line. A block comment begins with a slash followed by an asterisk, and terminates when an asterisk followed by a slash is met (/*...*/).

 
/* Start comment block
My Life Story
*/

 
// set up my bank account total
bank_account_total = 1000000 // Wish this was the case
 

[edit] FALSE

{comments are in curly braces}

[edit] Fish

Since ><> is a funge-like language, all characters not touched by the command pointer or modified by the p and g commands can be comments. Unlike Brainf***, unknown commands are not ignored by the compiler, they just raise an error.

v This is the Fish version of the Integer sequence task
>0>:n1+v all comments here
^o" "< still here
And of course here :)

[edit] Forth

Standard Forth includes a number of ways to add comment text. As with everything in Forth, comment characters are actually words that control the compiler.

\ The backslash skips everything else on the line
( The left paren skips everything up to the next right paren on the same line)

Traditionally, the paren comments are used for "stack effect" notation:

: myword ( a b -- c )  ...

This comment means "myword takes two cells on the stack and leaves one". Sometimes, stack effect comment names give clues about the word's function:

: add'em ( a b -- a+b )   + ;
: strlen ( addr -- len ) count nip ;

Some Forth systems implement other commenting words, such as these words from Win32Forth:

\s skips all remaining text in the file
(( skips until the next double-paren,
stretching across multiple lines ))
comment:
Ignore all text in this section
comment;
doc
Another comment block
enddoc
/* C-style comment */
(* Pascal-style comment *)

[edit] Fortran

Compiler: ANSI FORTRAN 77 or compatible (like g77 -strict)

The first six columns in Fortran are traditionally reserved for labels and certain special characters. In particular the letter "C" in the first column indicates a comment:

C     This would be some kind of comment
C Usually one would avoid columns 2-6 even in a comment.

Some Fortran compilers have the extension that comments starting with D are treated as non-comments if a special debugging flag is given at the compiler invocation. For example:

C     If compiled in debugging mode, print the current value of I
D PRINT *, I

ISO Fortran 90 or later have an inline comment (!) syntax:

real :: a = 0.0   ! initialize A to be zero

In ISO Fortran 90 or later, "C in first column" comments are only allowed in the "fixed" source form familiar to FORTRAN 77 programmers. The "free" source form only has inline comments (!}.

ISO Fortran 95 or later has an optional conditional compilation syntax. If present, it can be used (abused?) to (in effect) comment out blocks of code:

?? if (.false.) then
do while (oh_no)
a = bad_news()
b = big_mistake()
c = gigo()
end do
?? end if

[edit] Frink

 
// This is a single-line comment
 
/* This is a comment
that spans multiple lines
and so on.
*/
 

[edit] Gambas

In gambas, comments can be inserted by prefixing them with an apostrophe. The gambas interpreter will ignore the apostrophe and any other characters that follow it until the end of the line:

 
' This whole line is a comment and is ignored by the gambas interpreter
print "Hello" ' Comments after an apostrophe are ignored
 

[edit] GAP

# Comment (till end of line)

[edit] Gema

! comment starts with "!" and continues to end of line

A shebang (#!) may be used as a comment in the first line of a file.

[edit] GML

single-line comment:

 // comment starts with "//" and continues to the end of the line

multi-line comment:

 /* a multi-line comment starts with slash-asterisk and,
ends with asterisk-slash.
also note:
* A multi-line comment is ignored inside a string
* A multi-line comment can be ended inside a line
*/

[edit] gnuplot

# this is a comment
 
# backslash continues \
a comment to the next \
line or lines

The way backslash continues a comment means that comments can't usefully be put within a multi-line function definition,

# this doesn't work
foo(n) = (n \
+ 2 # no good \
+ 3)
 
# behaves as if you wrote merely
foo(n) = (n+2

[edit] Go

// this is a single line comment
/* this is
a multi-line
block comment.
/* It does not nest */

[edit] Golfscript

# end of line comment

[edit] Gri

# through to newline.

# this is a comment
show 123 # this too is a comment

// works similarly but is reckoned the "old way" (as of Gri 2.12.23)

// this is a comment
show 123 // this too is a comment

Both forms can be used in input data files too.

[edit] Groovy

See Java

[edit] GW-BASIC

Works with: GW-BASIC
100 REM Standard BASIC comments begin with "REM" (remark) and extend to the end of the line
110 PRINT "this is code": REM comment after statement

[edit] Haskell

i code = True -- I am a comment.
 
{- I am also
a comment. {-comments can be nested-}

let u x = x x (this code not compiled)
Are you? -}
 
-- |This is a Haddock documentation comment for the following code
i code = True
-- ^This is a Haddock documentation comment for the preceding code
 
{-|
This is a Haddock documentation block comment
-}

i code = True

[edit] Haxe

// Single line commment.
 
/*
Multiple
line
comment.
*/

[edit] HicEst

! a comment starts with a "!" and ends at the end of the line

[edit] HTML

<!-- Anything within these bracket tags is commented, single or multi-line. -->

[edit] Icon and Unicon

Any text after "#" is a comment.

# This is a comment
 
procedure x(y,z) #: This is a comment and an IPL meta-comment for a procedure
 

The The Icon Programming Library established conventions for commenting library additions and functions. This included both header block comments and meta comments on procedures within library files.

[edit] IDL

The comment character in IDL is the semicolon - everything starting with it and to the end of the line is a comment. Like this:

; The following computes the factorial of a number "n"
fact = product(indgen( n )+1) ; where n should be an integer

[edit] Inform 7

[This is a single-line comment.]
 
[This is a
multi-line comment.]
 
[Comments can [be nested].]

[edit] Io

# Single-line comment
 
// Single-line comment
 
/* Multi-line
comment */

[edit] J

NB. Text that follows 'NB.' has no effect on execution.
 
0 : 0
Multi-line comments may be placed in strings,
like this.
)
 
Note 'example'
Another way to record multi-line comments as text is to use 'Note', which is actually
a simple program that makes it clearer when defined text is used only to provide comment.
)

[edit] Java

Java has two ways to enter normal comments, plus a third type of comment that doubles as a way to generate HTML documentation.

[edit] C Style

/* This is a comment */
/*
* This is
* a multiple
* line comment.
*/

This C-style comment starts with /* and ends with */. The two delimiters may be on the same or separate lines. This style comment may be used anywhere white space is permitted.

[edit] C++ Style (inline)

// This is a comment

This C++-style comment starts with // and extends to the end of line.

[edit] Java Documentation (Javadoc)

/** This is a Javadoc comment */
/**
* This is
* a multiple
* line Javadoc comment
*/

Javadoc is a standardized documentation code for Java. Its comments begin with a forward slash and two stars. Javadoc comments have different tags that signify different things in the methods and classes that they precede.

[edit] Sneaky

Your editor will probably colour this as great big comment, but it compiles and prints "Hello World!". Once you've figured out how this works, try this discussion on why it's allowed.

public class JustComments {
/*
\u002A\u002F\u0070\u0075\u0062\u006C\u0069\u0063\u0020\u0073\u0074\u0061\u0074\u0069\u0063
\u0020\u0076\u006F\u0069\u0064\u0020\u006D\u0061\u0069\u006E\u0028
\u0053\u0074\u0072\u0069\u006E\u0067\u005B\u005D\u0061\u0072\u0067\u0073\u0029
\u007B\u0053\u0079\u0073\u0074\u0065\u006D\u002E\u006F\u0075\u0074\u002E
\u0070\u0072\u0069\u006E\u0074\u006C\u006E\u0028\u0022\u0048\u0065\u006C\u006C\u006F\u0022
\u002B\u0022\u0020\u0057\u006F\u0072\u006C\u0064\u0021\u0022\u0029\u003B\u007D\u002F\u002A
*/

}

[edit] JavaScript

See Java

[edit] JCL

first form

 
//* This is a comment line (//* in columns 1-3)
 

second form

 
/* This is also a comment line (/* in columns 1-3)
 

[edit] Joy

# this is a single line comment
 
(* this is a
multi-line comment *)

Multi-line comments cannot be nested.


[edit] jq

Except when a hash symbol (#) appears within a string, it begins a comment that continues to the end of the line:

# this is a single line comment
"Hello #world" # the first # on this line is part of the jq program
 

[edit] K

  / this is a comment
2+2 / as is this
 

[edit] KonsolScript

//This is a comment.
//This is another comment.
 
/* This is a comment too. */
 
/* This is a
multi-line
comment */

[edit] LabVIEW

This image is a VI Snippet, an executable image of LabVIEW code. The LabVIEW version is shown on the top-right hand corner. You can download it, then drag-and-drop it onto the LabVIEW block diagram from a file browser, and it will appear as runnable, editable code.
LabVIEW Comments.png

[edit] Lang5

# This is a comment.

[edit] Lasso

//This is a comment.
 
/* This is also a comment. */
 
/* A multi-line
comment */
 
/* ==========================
A multi-line
comment
=========================== */

[edit] LaTeX

In LaTeX, comments look like this:

% This is a comment

LaTeX comments start with % and continue up to and including the line break. The fact that the line break itself is commented out as well makes it useful for adding line breaks in the source code of complex macros without LaTeX interpreting them (which may cause extra space or even a paragraph break in the resulting typeset text). For example, the following results in the one word "understandable":

\newcommand{\firstpart}{understand}
\newcommand{\secondpart}{able}
\newcommand{\complete
}{%
\firstpart%
\secondpart}
 
\complete

Without the percent sign after \firstpart, it would have been the two words "understand able".

[edit] Liberty BASIC

'This is a comment
REM This is a comment
 
print "This has a comment on the end of the line." 'This is a comment
print "This also has a comment on the end of the line." : REM This is a comment

[edit] Lilypond

% This is a comment
 
%{ This is a comment
spanning several lines %}

[edit]

; comments come after a semicolon, and last until the end of the line

[edit] Logtalk

% single-line comment; extends to the end of the line
/* multi-line
comment */

[edit] LotusScript

LotusScript has two ways to enter comments.

' This is a comment

Wherever the single quote (') is used, the rest of the line is treated as a comment and ignored. Multi-line comments would each need a single quote mark. This style of comment is usually used for making small in-line or single line comments.

%REM
This is a multi-
line comment.
%END REM

A %REM marker begins a comment block, and a %END REM marker ends the comment block. This style of comment is used for making longer multi-line comments, often at the beginning of a class, sub or function.

[edit] LSE64

# single line comment (space after # is required)

The author of LSE comments the stack effect of words with header comments as follows:

# arg1 arg2 '''yields''' result|''nothing''

[edit] Lua

-- A single line comment
 
--[[A multi-line
comment --]]
Works with: Lua version 5.1 and above
--[====[ A multi-line comment that can contain [[ many square brackets ]]
]====]

[edit] M4

eval(2*3)  # eval(2*3)  "#" and text after it aren't processed but passed along
 
dnl this text completely disappears, including the new line
 
divert(-1)
Everything diverted to -1 is processed but the output is discarded.
A comment could take this form as long as no macro names are used.
divert
Output:
6  # eval(2*3)  "#" and text after it aren't processed but passed along

dnl must be a separate word. An empty pair of quotes can separate it from preceding text if necessary

some text`'dnl then a deleted comment

changecom() can set a different character for #,

changecom(%)
% now percent prevents macro expansion

In GNU m4 an empty changecom() string means no such commenting char at all (but in BSD m4 means reset to the default #)

changecom()
GNU m4 now no macro expansion suppression character at all

In GNU m4 changecom() also takes separate start and end strings and they can be multi-character sequences, allowing for example C style,

changecom(/*,*/)
/* GNU m4 now no macro expansion in C style comments */


[edit] Maple

x := 4: x; # Everything on this line, after this, is a comment.
 
17; (* This
is
a multiline comment *) 23.4;
Output:
                               4
                               17
                              23.4

[edit] Mathematica

(*this is a comment*)

It can be used everywhere and nested if necessary:

If[a(*number 1*)<(* is smaller than number 2*) b, True (*return value (*bool true*)*), False (*return bool false*)]

evaluates to:

If[a < b, True, False]

[edit] MATLAB

%This is a comment
%% Two percent signs and a space are called a cell divider

[edit] Maxima

/* Comment
/* Nested comment */
*/

[edit] MAXScript

-- Two dashes precede a single line comment
 
/* This is a
multi-line comment */

[edit] MBS

! A pling in a line starts a comment
 
INT n:=5  ! Comments can appear at the end of a line
 
/* A comment block can also be defined using climbstar and starclimb symbols.
This allows comments to be stretched across several lines */

[edit] Metafont

% this is "to-end-of-line" comment

[edit] Mirah

puts 'code' # I am a comment
/* This is
* a multiple
* line comment */
 

[edit] mIRC Scripting Language

;Single Line Comment
/*
Multiple
Line
Comment
*/

[edit] Modula-2

(* Comments (* can nest *) 
and they can span multiple lines.
*)

[edit] Modula-3

(* Comments (* can nest *) 
and they can span multiple lines.
*)

[edit] Monte

 
# This comment goes to the end of the line
/** This comment is multi-line.
Yes, it starts with a two stars
and ends with only one.
These should only be used for docstrings. */
 

[edit] MOO

"String literals are technically the only long-term comment format";
// Some compilers will, however, compile // one-liners to string literals as well (and vice-versa)
/* Classical C-style comments are removed entirely during compile */

[edit] Neko

// Single line comment, of course!
/*
Multi line comment!
*/

[edit] Nemerle

// This comment goes up to the end of the line
/* This
is
a
multiline
comment */

[edit] NetRexx

NetRexx supports block-comments and line comments. Block comments are started with a /* and terminated with a */. Line comments follow a -- sequence anywhere on a line. NetRexx supports nested comments (see REXX).

/*
 
NetRexx comment block
 
*/

 
-- NetRexx line comment
 
 

[edit] NewLISP

A comment is started by ; and reaches to the end of the line.

; This is a comment

[edit] Nimrod

# Nimrod supports only single-line comments
 
var x = 0 ## Documentation comments start with double hash characters.
 
var y = 0 ## Comments are a proper part of the syntax and are indentation sensitive.
## If the next line only consists of a comment piece, it must be aligned
## either to the preceding one (documentation generator would merge these lines)
## or to the code block (starting a new comment piece).
 
# any misaligned comment line (like this one) would trigger an "invalid indentation" error
 
var z = 0 ## Alternatively you can end the preceding comment piece with a backslash \
## to reset alignment to any column you like.
## See also http://nimrod-code.org/tut1.html#comments

[edit] NSIS

 
# This is a comment that goes from the # to the end of the line.
; This is a comment that goes from the ; to the end of the
 
/* This is a
multi-line
comment */

 

[edit] Objeck

 
#This is a comment.
# This is other comment.
 
#~ This is a comment too. ~#
 
#~ This is a
multi-line
comment ~#

 

[edit] Objective-C

See C

[edit] OCaml

(* This a comment
(* containing nested comment *)
*)

 
(** This an OCamldoc documentation comment *)

[edit] Octave

# I am a comment till the end of line
% I am a comment till the end of line

%{
This comment spans
multiple lines
%}

 

[edit] ooRexx

Comments in ooRexx follow the same rules as REXX and NetRexx

/*
Multi-line comment block
*/

 
-- this type of comment works in ooRexx, NetRexx and some of the more popular REXX implementations like Regina
 
hour = 0 -- which is, like midnight, dude.
 
hour = 12 /* time for lunch! works as well (and really everywhere) */
 
 

[edit] Openscad

The openscad geometry compiler supports C++ style comments:

 
// This is a single line comment
 
/*
This comment spans
multiple lines
*/
 
 

[edit] OxygenBasic

 
' Basic line comment
; Assembly code line comment
// C line comment
/* C block comment */
 

[edit] Oz

% one line comment
 
%% often with double "%" because then the indentation is correct in Emacs
 
/* multi line
comment
*/

 

[edit] PARI/GP

Comments are similar to C. The block comment is identical: /* comment */. The line comment uses backslashes instead of slashes: \\ comment.

[edit] Pascal

(* This is a comment.
It may extend across multiple lines. *)

 
{ Alternatively curly braces
can be used. }

 
(* This is a valid comment in Standard Pascal,
but not valid in [[Turbo Pascal]]. }
 
{ The same is true in this case *)

In Pascal, comments cannot be nested.

[edit] PASM

# This is a comment
print "Hello\n" # This is also a comment
end

[edit] Perl

Works with: Perl version 5.x

Single line comment

# this is commented

These may also be at the end of a line

my $var = 1; # this is the comment part

Multi-line comments for inline documentation (Plain Old Documentation, or POD in Perl parlance) follow the format:

=pod
 
Here are my comments
this is multi-line
 
=cut

Note that technically, both of the lines beginning with the equals sign must be surrounded on either side for compatibility with all "POD" parsers.

Note also that any string beginning with an equals sign, and that appears in the initial column of a line, begins a multi-line comment. It does not have to be a POD "command:" the following are all valid:

=head1
=head4
=over 4
=Any Old String

Such blocks always end in =cut.

For more info, type at a command prompt (or into a search engine): "perldoc perlpod"

[edit] Perl 6

my $x = 2; # Single-line comment.
 
#`(
Comments beginning with a backtick and one or more
opening bracketing characters are embedded comments.
They can span more than one line…
)
 
my $y = #`{ …or only part of a line. } 3;
 
#`{{
Using more than one bracketing character lets you include
an unmatched close bracket, like this: }
}}
 
#`⁅ Synopsis 2: "Bracketing characters are defined as any
Unicode characters with either bidirectional mirrorings or
Ps/Pe/Pi/Pf properties." ⁆
 
=begin comment
 
Pod is the successor to Perl 5's POD. This is the simplest way
to use it for multi-line comments. For more about Pod, see
Synopsis 26:
 
http://perlcabal.org/syn/S26.html
 
=end comment

[edit] PHP

Single line comment:

# this is commented
// this is commented

These may also be at the end of a line:

$var = 1; # this is the comment part
$var = 1; // this is the comment part

Basic syntax for multi-line comments:

/*
Here are my comments
this is multi-line
*/

Note that; it is more common to see phpDocumentor styled multi-lined comments:

/**
* phpdoc Comments
* @todo this is a todo stub
*/

[edit] PicoLisp

# The rest of the line is ignored
#{
This is a
multiline comment
}#
NIL
Immediately stop reading this file. Because all text in the input file following
a top-level 'NIL' is ignored.
 
This is typically used conditionally, with a read-macro expression like
`*Dbg
so that this text is only read if in debugging mode.

[edit] Pike

// This is a comment.
/* This is a
multi
line
comment */

 
int e = 3; // end-of-statement comment.

[edit] plainTeX

The default raw/bare TeX assigns the category code 14 (comment character) to the character %, and plainTeX, as also LaTeX (see here Comments in LaTeX, does not change it; so the % starts a to-end-of-line comment in many TeX macro packages.

% this is a comment
This is not.

The final newline character is eaten and since it normally behaves like a space, the comment can be used to hide the newline:

\def\firstpart{understand}
\def\secondpart{able}
\def\complete{\firstpart%
\secondpart}
 
\complete

Outputs understandable; without % it would output understand able.

[edit] PL/I

/* This is a comment. */
/* 
This is a multiline comment.
*/

Note: In PL/I, comments cannot be nested.

[edit] PL/SQL

Single line comment:

--this is a single line comment

Multiline comment:

/*
this is a multiline
comment
*/

End of line comment:

v_var NUMBER; --this is an end of line comment

[edit] Pop11

Pop11 has two kinds of comments: endline and C-like. Endline comment begins with tree consecutive semicolons and ends at the end of line:

;;; This is a comment

C-like comments may be multiline:

/* First line
Second line */

C-like comments (unlike C) may be nested:

/* This is a comment /* containing nested comment */ */

One can also use conditional compilation to comment out sections of code

#_IF false
some code
#_ENDIF

however, commented out part must consist of valid Pop11 tokens. In particular, C-like comments must balance and strings must be terminated. The following is an error:

#_IF false
This w'ont work
#_ENDIF

because apostrophe starts an unterminated string.

[edit] PostScript

 
%This is a legal comment in PostScript
 

[edit] PowerShell

# single-line comment
Works with: PowerShell version 2
<# multi-line
comment #>

[edit] ProDOS

I don't know why this is even a task because it should be included in any decent programming language.

IGNORELINE your text here

[edit] Prolog

% this is a single-line comment that extends to the end of the line
/* This is a
multi-line comment */

[edit] Protium

Protium encloses all comments inside <@ OMT></@> (fixed length opcode) or <# OMIT></#> (variable length opcode) whether single- or multi- line.

 
<@ OMT>This is a
multiline
comment</@>
 

OMT suppresses evaluation of everything contained. There are a variety of extra opcodes which can be used to control how OMT functions at run time.

[edit] PureBasic

PureBasic uses the ";" symbol to mark its comments. All text entered after ";" on a line is ignored by the compiler.

;comments come after an unquoted semicolon and last until the end of the line
foo = 5 ;This is a comment
c$ = ";This is not a comment" ;This is also a comment

[edit] Python

Python uses the "#" symbol to mark it's comments. After placing a "#", everything to the right of it in that line will be ignored.

# This is a comment
foo = 5 # You can also append comments to statements

Certain 'do nothing' expressions resemble comments

"""Un-assigned strings in triple-quotes might be used 
as multi-line comments
"""

 
'''
"triple quoted strings" can be delimited by either 'single' or "double" quote marks; and they can contain mixtures
of other quote marks without any need to \escape\ them using any special characters. They also may span multiple
lines without special escape characters.
'''

Note that strings inserted among program statements in Python are treated as expressions (which, in void context, do nothing). Thus it's possible to "comment out" a section of code by simply wrapping the lines in "triple quotes" (three consecutive instances of quotation marks, or of apostrophes, and terminated with a matching set of the same).

[edit] Documentation Strings

Python makes pervasive use of strings which immediately follow class and function definition statements, and those which appear as the first non-blank, non-comment line in any module or program file. These are called "documentation" strings or "docstrings" for short; and they are automatically associated with the __doc__ attribute of the class, function, or module objects in which they are defined. Thus a fragment of code such as:

#!/usr/bin/env python
# Example of using doc strings
"""My Doc-string example"""
 
class Foo:
'''Some documentation for the Foo class'''
def __init__(self):
"Foo's initialization method's documentation"
 
def bar():
"""documentation for the bar function"""
 
if __name__ == "__main__":
print (__doc__)
print (Foo.__doc__)
print (Foo.__init__.__doc__)
print (bar.__doc__)


... would print each of the various documentation strings in this example. (In this particular example it would print two copies of the first doc string which because __doc__ in the "current" name space is the same as __main__.__doc__ when our program is running as a script). If some other script were to import this file (under the name "example" perhaps) then "My Doc-string example" would be the value of example.__doc__

Python "docstrings" are used by a number of tools to automatically generate documentation (for most of the Python standard libraries, classes, functions, etc, as well as for user programs which define docstrings). They are also used by tools such as doctest to automatically derive test suites from properly formatted examples of class instantiations, function invocations and other usage samples. The standard pydoc utility can search through Python source trees generating documentation and can function as a local web server allowing a programmer to browse "live" hyperlinked documentation of their project.

(As noted above extraneous strings interspersed throughout a Python source file can be used as comments, though this is rarely done in practice; only those strings which lexically follow the definition of a class, function, module or package are assigned to __doc__ attributes in their respective name spaces).

[edit] R

# end of line comment

[edit] Racket

 
; this is a to-end-of-line coment
 
#| balanced comment, #| can be nested |# |#
 
#;(this expression is ignored)
 
#; ; the following expression is commented because of the #; in the beginning
(ignored)
 
 

[edit] Raven

 # this is a comment


[edit] REALbasic

//Comments are denoted by a preceding double slash or or single quote
'and continue to the end of the line. There are no multi-line comment blocks
Dim foo As Integer //Comments can also occupy the ends of code lines

[edit] REBOL

 
; This is a line comment.
 
{ Multi-line strings can
be used as comments
if you like }
 

Functions have special commenting options which make them self documenting:

 
plus2: func [
"Adds two to a number."
n [number!] "The number to increase."
][
n + 2
]
 

If you say "help plus2" at REBOL's REPL, you'll get this help information:

   USAGE:
       PLUS2 n
   
   DESCRIPTION:
        Adds two to a number.
        PLUS2 is a function value.
   
   ARGUMENTS:
        n -- The number to increase. (Type: number)

[edit] Retro

( comments are placed between parentheses. A space must follow the opening parenthesis. )

[edit] REXX

It should be noted that comments in the REXX language support nested comments, so comments aren't totally ignored by the REXX interpreter (and compiler).

REXX comments are scanned and preserved for use by the sourceline bif.   [The sourceline bif allows the retrieval of any or all lines of source.]
Also, redundant blanks are removed and processed/shown for various trace options (TRACE is a REXX statement that may show various interpretation/execution stages of REXX statements, including comments and blank lines).

Nested comments must have matching delimiters, so the contents of the comments can't just be willy-nilly characters.

The REXX language was heavily modeled after PL/I, both languages have the same comment construct, but PL/I doesn't support nested comments.

Nested comments allow an easy way to comment large chunks of code where the commented-out code has its own comments.

/*REXX program to demonstrate various uses and types of comments. */
 
/* everything between a "climbstar" and a "starclimb" (exclusive of literals) is
a comment.
climbstar = /* [slash-asterisk]
starclimb = */
[asterisk-slash]
 
/* this is a nested comment, by gum! */
/*so is this*/
 
Also, REXX comments can span multiple records.
 
There can be no intervening character between the slash and asterisk (or
the asterisk and slash). These two joined characters cannot be separated
via a continued line, as in the manner of:
 
say 'If I were two─faced,' ,
'would I be wearing this one?' ,
' --- Abraham Lincoln'
 
Here comes the thingy that ends this REXX comment. ───┐



 
*/
 
hour = 12 /*high noon */
midnight = 00 /*first hour of the day */
suits = 1234 /*card suits: ♥ ♦ ♣ ♠ */
 
hutchHdr = '/*'
hutchEnd = "*/"
 
/* the previous two "hutch" assignments aren't
the start nor the end of a REXX comment. */

 
x=1000000 ** /*¡big power!*/ 1000
 
/*not a real good place for a comment (above),
but essentially, a REXX comment can be
anywhere whitespace is allowed. */

Some REXX implementations (e.g. Regina, ooRexx) also allow line comments which start with a   --   sequence and extend to the end of the line:

[Note: Regina releases since 3.4 allow this type of single-line comment only if the option noSingle_Line_comments isn't present in the REGINA_OPTIONS environmental variable. So, Regina may allow the use of single-line comments. That is to say, one can't depend (or assume) that the Regina extension (of single-line comments) for the aforementioned option will be or not be present (supported and/or allowed) in the environment being used].   Which means you should set this option to your preference if using Regina REXX later than version 3.3.


-- A REXX line comment
say "something" -- another line comment

[edit] RLaB

RLaB only has single line comment indicator, as in following examples

 
x = "code" # I am a comment
x = "code" // Here I comment thee
# matlab-like document line
// C++ like document line
 

[edit] Ruby

x = "code" # I am a comment
 
=begin hello
I a POD documentation comment like Perl
=end
puts "code"

[edit] Run BASIC

Comments have a ' (single quote) or REM for remarks

'This is a comment
REM This is a comment
 
print "Notice comment at the end of the line." 'This is a comment
print "Also notice this comment at the end of the line." : REM This is a comment
 

[edit] Rust

// A single line comment
 
/*
This is a multi-line (aka block) comment
 
/*
containing nested multi-line comment
(nesting supported since 0.9-pre https://github.com/mozilla/rust/issues/9468)
*/
*/
 
 
/// Outer single line Rustdoc comments apply to the next item.
 
/**
Outer multi-line Rustdoc comments.
 
* Leading asterisk (*) in multi-line Rustdoc comments
* is not considered to be part of the comment text,
* blanks and tabs preceding the initial asterisk (*) are also stripped.
*/
 
fn example() {
 
//! Inner single line Rustdoc comments apply to their enclosing item.
 
/*!
Inner multi-line Rustdoc comments.
See also https://github.com/mozilla/rust/wiki/Doc-using-rustdoc
*/
}
 
#[doc = "Unsugared outer Rustdoc comments.
(outer attributes are not terminated by a semi-colon)"]
fn example() {
#[doc = "Unsugared inner Rustdoc comments.
(inner attributes are terminated by a semi-colon)
See also https://github.com/mozilla/rust/blob/master/doc/rust.md#attributes"];
}

[edit] SAS

/* comment */
 
*another comment;
 
* both
may
be
multiline;

[edit] Sather

-- a single line comment

[edit] Scala

// A single line comment
 
/* A multi-line
comment */

[edit] Scheme

; Basically the same as Common Lisp
; While R5RS does not provide block comments, they are defined in SRFI-30, as in Common Lisp :
 
#| comment
... #| nested comment
... |#

|#
 
; See http://srfi.schemers.org/srfi-30/srfi-30.html
 

[edit] Seed7

# A single line comment
 
(* A multi-line
comment *)
 
(* In Seed7,
(* comments can be nested. *) *)

[edit] Sidef

Single line comment

# this is commented

These may also be at the end of a line

var i = 1; # this is the comment part

Embedded comments

var distance #`{in meters} = (30 #`{meters} * 100 #`{seconds});
say distance; # prints: 3000

Multi-line comments

/*
This is a multi-line comment
*/

[edit] Slate

"basically the same as smalltalk"

[edit] Smalltalk

"Comments traditionally are in double quotes."
"Multiline comments are also supported.
Comments are saved as metadata along with the source to a method.
A comment just after a method signature is often given to explain the
usage of the method. The class browser may display such comments
specially."

[edit] SNOBOL4

 
* An asterisk in column 1 is the standard Snobol comment
* mechanism, marking the entire line as a comment. There
* are no block or multiline comments.
 
* Comments may begin at
* any position on the line.
 
- A hyphen in column 1 begins a control statement.
- Unrecognized control statements are ignored and
- may also mark comment lines. Not recommended.
 
 ;* The semicolon statement separator
output = 'FOO' ;* begins a new statement. This idiom
output = 'BAR' ;* simulates an asterisk in the first
 ;* column, allowing end of line comments.
 
END
 
Any text after the required END label is ignored.

[edit] SNUSP

As with Brainf*** and Befunge, any character that is not part of the language is ignored and can be used as commentary, and you can add comments anywhere the instruction pointer is not expected to traverse. Reserved characters are:

  • Core: + - > < , . ? ! / \ $ #
  • Modular: @ #
  • Bloated: : ; & %

As a matter of convention, the characters '=' and '|' are used for spacing to indicate horizontal and vertical flow of control, respectively.

[edit] SQL

The double hyphen ( -- ) is used to include a comment on an SQL statement.

The comment appears on the same line as the statement:

SELECT * FROM mytable -- Selects all columns and rows

or before:

-- Selects all columns and rows
SELECT * FROM mytable

or after:

SELECT * FROM mytable 
-- Selects all columns and rows

[edit] Standard ML

(* This a comment
(* containing nested comment *)
*)

[edit] Swift

// this is a single line comment
/* This a block comment
/* containing nested comment */
*/
 
///This is a documentation comment
 
/**
This is a documentation block comment
*/

[edit] Tcl

Tcl follows the usual scripting language rules: a comment starts at a "#" symbol, which can be placed after a command if that is terminated by a semicolon:

# comment on a line by itself. The next is a command by itself:
set var1 $value1
set var2 $value2 ; # comment that follows a line of code

The reason for the need for a semi-colon on a trailing comment is this:

"If a hash character (“#”) appears at a point where Tcl is expecting the first character of the first word of a command, then the hash character and the characters that follow it, up through the next newline, are treated as a comment and ignored. The comment character only has significance when it appears at the beginning of a command." (from the Tcl man page -- emphasis mine)

The "#" symbol has no special meaning if it is not where a command would appear -- it's just data. (Syntax highlighters often get this wrong.)

set aList {foo}
lappend aList # bar
puts $aList ;# ==> prints "foo # bar"
puts [llength $aList] ;# ==> 3

TCL has no native multi-line comment format. However, in most circumstances, a multi-line comment can be faked by wrapping it within a block that will never be executed:

if 0 {
Comments...
}

[edit] TI-83 BASIC

There is no 'proper' way of adding comments in TI-BASIC, however there are ways to add text to a program that will be ignored by the calculator.

One common approach is to put the comment in a string which is not stored anywhere:

:"THIS IS A COMMENT

However this will change the Ans variable.

This approach, while messier, does not affect the Ans variable:

:If 0
:THIS IS A COMMENT


[edit] TI-89 BASIC

© This is a comment. Everything from © to the end of the line is ignored.

[edit] Toka

There are two ways to add comments in Toka. For full lines, or at the end of a line, the shebang is normally used:

#! Everything on this line (after the shebang to the left) will be ignored.

The shebang comments can not be used inside of functions.

In addition, Toka also accepts parenthetical comments. These are enclosed in parenthesis, and are often used for stack comments or comments inside functions.

[ ( a b -- c ) 
... ] is myword

In addition, parenthetical comments can span multiple lines.

( This is a
simple, multi-line
comment )

Since comments are provided by actual functions, the comment function must be whitespace delimited, just as with all other functions in Toka.

A final way to include text in a file is to mark a false ending with end.

... code ....
end.
Nothing following the end. will be evaluated by Toka.

[edit] TorqueScript

//This is a one line comment. There are no other commenting options in TorqueScript.

[edit] TPP

--## comments are prefixed with a long handed double paintbrush

[edit] TUSCRIPT

 
$$ MODE TUSCRIPT
- This is a comment
 

[edit] TXR

@# old-style comment to end of line
@; new-style comment to end of line
@(bind a ; comment within expression
"foo")

[edit] UNIX Shell

Works with: Bourne Shell
#!/bin/sh
# A leading hash symbol begins a comment.
echo "Hello" # Comments can appear after a statement.
 
# The hash symbol must be at the beginning of a word.
echo This_Is#Not_A_Comment
#Comment

[edit] C Shell

#!/bin/csh -f
 
# C Shell has a similar comment syntax, but only allows comments in a
# script file, not in terminal input.
 
echo Hello#With C Shell, the hash can also be in the middle of a word.

[edit] es

# Comments in es (extensible shell) look like those of other shells.
 
echo Hello#With es, the hash can also be in the middle of a word.

[edit] Unlambda

Unlambda comments start with # and extend to the end of the line:

# this is a comment.

Note that comments don't need to start at the beginning of a line, e.g.

`  # apply
.a # output "a"
i  # identity

is equivalent to

`.ai

[edit] Ursala

There are lots of ways to have comments in Ursala. Here are the conventional ones.

# this is single line a comment
 
# this is a\
continued comment
 
(# this is a
multi-line comment #)
 
(# comments in (# this form #) can (#
be (# arbitrarily #) #) nested #)
 
---- this is also a comment\
and can be continued
 
###
The whole rest of the file after three hashes
is a comment.

[edit] Commenting out code

There are also ways to comment out sections of code during testing. An individual item of a syntactically correct list or aggregate is commented out like this.

x = <1,## 2,3>

The 2 is ignored but 1 and 3 aren't. This also works with nested aggregates and multiple lines.

a =
 
<
'to',
## <
'be',
'or'>,
'not',
'to',
## 'be'>

A syntactically correct declaration can be commented out like this.

foo = 1
 
##
 
bar = 2
 
baz = 3

As far as the compiler is concerned, bar is not defined, but foo and baz are. It wouldn't matter if bar took multiple lines.

[edit] Comments in compiled files

The compiler can be directed to embed comments in executable files and libraries it generates without affecting their semantics.

#comment -[
I document the source text but will also be embedded in
the output library or executable file.]-
 
#comment gpl'3'

The latter comment puts the standard GPL license notification in the output file.

[edit] Comments as diagnostics

A function f annotated with a crash dump wrapper expressed like this during debugging

my_input_type%C f

is equivalent to just f when changed to this in the production code.

my_input_type%Ck f

[edit] Comments as hooks

Compiling with the --depend command line option makes the compiler only scan for the #depend'ed expressions and send them to standard output.

#depend <this,expression> is (parsed)* but {
otherwise,
ignored}

This way, scripts and source management tools can have information passed to them from the programmer by running the compiler instead of re-implementing their own parsers.

[edit] Verilog

// Single line commment.
 
/*
Multiple
line
comment.
*/

[edit] VHDL

-- Single line commment in VHDL

[edit] Vim Script

All lines starting with " are comments and will be ignored.

In most cases, " will also work after a command (i.e. the rest of the line will be ignored). But some commands like echo treat the whole line as their argument and thus will raise an error (Missing quote).

let a = 4 " A valid comment
echo "foo" " Not a comment but an argument that misses the closing quote

[edit] Visual Basic

In addition to the methods mentioned in BASIC above, it is also somewhat common to effectively comment out code by including the unwanted code inside an #If 0 ... #End If block. (This works because 0 evaluates to False in VB.) Note, however, that the IDE will complain about actual comments inside an #If 0 block unless it's also commented normally (i.e., using Rem or ').

'comment
Rem comment
#If 0
Technically not a comment; the compiler may or may not ignore this, but the
IDE won't. Note the somewhat odd formatting seen here; the IDE will likely
just mark the entire line(s) as errors.
#End If

[edit] Visual Basic .NET

Visual Basic .NET uses the "'" symbol or "REM" to mark it's comments. After placing a "'", or "REM", everything in that line will be ignored.

' This is a comment
REM This is also a comment
Dim comment as string ' You can also append comments to statements
Dim comment2 as string REM You can append comments to statements

[edit] Vorpal

# single line comment

[edit] Wart

# single line comment

[edit] XPL0

Comments are enclosed in backslash characters, but the end of a line always terminates a comment. Consequently there is no multi-line comment. For example:

Text(0, \comment\ "Hello \not a comment\ World!"); \comment

Since backslashes toggle comments on and off, it could be inconvenient to comment out a line of code that contains a comment. For example, two additional backslashes could be used to comment out this line, as shown here:

 Text(0, "Hello World");  \comment
\Text(0, "Hello World"); \\comment

However, two backslashes together comment out everything to the end of the line regardless of any backslashes the line might contain. So the first example could be commented out like this:

\\Text(0, \comment\ "Hello \not a comment\ World"); \comment

Conditional compilation can be used to effectively comment out multiple lines of code. For example:

cond false;
Text(0, "Hello World"); \comment
CrLf(0);
cond true;

[edit] XQuery

(: This is a XQuery comment :)

[edit] XSLT

<!-- Comment syntax is borrowed from XML and HTML. -->

[edit] XUL

<!-- Comment syntax is borrowed from XML and HTML. -->

[edit] zkl

x=1; // comment ala C++
x=2; # ala scripts
/* ala C */
/* can /* be */ nested */
#if 0
also ala C
#endif
Personal tools
Namespaces

Variants
Actions
Community
Explore
Misc
Toolbox