Comment Syntax

程式或網站服務設定檔的註解語法 (Comment syntax for programming languages or server configuration file) << Testing

A: Apache config

Configuration Files - Apache HTTP Server Version 2.4

# single line comment

B: Bash (shell script)

Bash (Unix shell)

# single line comment

C: CSS, Cron

CSS Code: viewable when user view the HTML source code

/* multiple lines
comments
*/

Conditional Comments for IE

Cron jobs code

# single line
# 0 0 * * 0 execute some script weekly

D: DOS, Dockerfile

DOS Command Code:

REM [comment]
ex: REM single line comment

Dockerfile or compose file (docker-compose.yml)

# single line comment

H: HTML

HTML Code: viewable when user view the HTML source code

<!-- This is an HTML Comment -->

<!-- multiple 
lines -->

J: Javascript, Java, JSP

Javascript Code: viewable when user view the HTML source code

//single line comment

/* multiple 
lines
*/

Java & JSP

//single line comment

/* multiple 
lines
*/

M: MySQL

MySQL configuration file

# single line comment

-- single line comment. Note there are one space between '--' with 'single line comment'.

/* multiple
   lines
   comments
*/

P: Perl, PHP, Postman, Python

Perl Code:

# single line comment

PHP Code: not viewable when user view the HTML source code

# single line comment
// another single line comment

/* multiple 
lines
*/

php.ini

; single line comment

Postman

// single line comment

Python: The IPython Notebook

# single line comment

'''
This is the multiline
comments.
'''

R

R: The R Project for Statistical Computing: Commenting Guidelines

# single line comment

Multiline lines comment : Use RStudio (Editing and Executing Code – RStudio Support) to comment/uncomment the selected code. r - Multiline Comment Workarounds? - Stack Overflow

S: SIKULI, SQL

SIKULI Code: ( multiple line comment is not supported for SIKULI IDE 1.x[1])

# single line comment

SQL Command / MySQL 5.1 Comment Syntax:

-- single line comment

/* multiple 
lines
*/

V: VBScript

VBScript Coding Conventions, VBScript Tutorial - Operators

' single line comment

X: XML

XML Code :

<!--
	multiple lines
-->

References

further reading

• 五種應該避免的代碼注釋 - 陳皓專欄(簡體)
• Comment (computer programming) - Wikipedia, the free encyclopedia
• PHPUnit Manual – Appendix B. Annotations