Editing Comment Syntax

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

== A: Apache config ==
[https://httpd.apache.org/docs/2.4/configuring.html#syntax Configuration Files - Apache HTTP Server Version 2.4]
<pre>
# single line comment
</pre>


== B: Bash (shell script) ==
[http://en.wikipedia.org/wiki/Bash_(Unix_shell) Bash (Unix shell)]
<pre>
# single line comment
</pre>

== C: CSS, Cron ==
CSS Code: '''viewable''' when user view the HTML source code<ref>[http://www.w3schools.com/css/css_syntax.asp CSS Syntax]</ref>
<pre>
/* multiple lines
comments
*/
</pre>

[http://msdn.microsoft.com/en-us/library/ms537512(v=vs.85).aspx Conditional Comments] for {{IE}}

[https://zh.wikipedia.org/wiki/Cron Cron] jobs code<ref>[https://www.webhostingtalk.com/showthread.php?t=619350 How to comment cron job? | Web Hosting Talk]</ref>
<pre>
# single line
# 0 0 * * 0 execute some script weekly
</pre>

==D: DOS, Dockerfile ==
DOS Command Code<ref>[http://www.csulb.edu/~murdock/rem.html DOS Command:  REM]</ref>:
<pre>
REM [comment]
ex: REM single line comment
</pre>

Dockerfile or [https://docs.docker.com/compose/compose-file/ compose file] (docker-compose.yml)

<pre>
# single line comment
</pre>

==H: HTML==
HTML Code: '''viewable''' when user view the HTML source code
<pre>
<!-- This is an HTML Comment -->

<!-- multiple 
lines -->
</pre>

==J: Javascript, Java, JSP==
Javascript Code: '''viewable''' when user view the HTML source code
<pre>
//single line comment

/* multiple 
lines
*/
</pre>


Java<ref>[http://www.oracle.com/technetwork/articles/java/index-137868.html How to Write Doc Comments for the Javadoc Tool]</ref> & JSP<ref>[http://www.xyzws.com/JSPfaq/how-to-use-comments-in-jsp-pages/8 How to use comments in JSP pages?]</ref>
<pre>
//single line comment

/* multiple 
lines
*/
</pre>

== M: MySQL ==
MySQL configuration file
<pre>
# single line comment

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

/* multiple
   lines
   comments
*/
</pre>

==P: Perl, PHP, Postman, Python==
Perl Code<ref>[http://www.tizag.com/perlT/perlsyntax.php perl - syntax]</ref>:
<pre>
# single line comment
</pre>


PHP Code: '''not viewable''' when user view the HTML source code<ref>[http://www.tizag.com/phpT/comment.php using comments in php]</ref>
<pre>
# single line comment
// another single line comment

/* multiple 
lines
*/
</pre>


php.ini
<pre>
; single line comment
</pre>

Postman<ref>[https://github.com/postmanlabs/postman-app-support/issues/3358 Feature request: Raw body editor JSON comment · Issue #3358 · postmanlabs/postman-app-support · GitHub]</ref>
<pre>
// single line comment
</pre>

Python: [http://ipython.org/notebook.html The IPython Notebook]<ref>[http://nbviewer.ipython.org/urls/raw.github.com/ricardoduarte/python-for-developers/master/Chapter2/Chapter2_Syntax.ipynb Python for Developers - Chapter 2: Syntax]</ref><ref>[http://stackoverflow.com/questions/7696924/multiline-comments-in-python Multiline comments in Python - Stack Overflow]</ref>
<pre>
# single line comment
</pre>

<pre>
'''
This is the multiline
comments.
'''
</pre>

== R ==
[https://www.r-project.org/ R: The R Project for Statistical Computing]: [https://google.github.io/styleguide/Rguide.xml#comments Commenting Guidelines]

<pre>
# single line comment
</pre>

Multiline lines comment : Use [https://www.rstudio.com/ RStudio] ([https://support.rstudio.com/hc/en-us/articles/200484448-Editing-and-Executing-Code Editing and Executing Code – RStudio Support]) to comment/uncomment the selected code. [http://stackoverflow.com/questions/1231195/multiline-comment-workarounds r - Multiline Comment Workarounds? - Stack Overflow]

==S: SIKULI, SQL==
[http://groups.csail.mit.edu/uid/sikuli/ SIKULI] Code: ({{exclaim}} multiple line comment is not supported for SIKULI IDE 1.x[https://bugs.launchpad.net/sikuli/+bug/585342])
<pre>
# single line comment
</pre>

SQL Command / [http://dev.mysql.com/doc/refman/5.1/en/comments.html MySQL 5.1 Comment Syntax]:
<pre>
-- single line comment

/* multiple 
lines
*/
</pre>

==V: VBScript ==
[http://msdn.microsoft.com/en-us/library/ektke1b0(VS.85).aspx VBScript Coding Conventions], [http://www.tizag.com/vbscriptTutorial/vbscriptoperators.php VBScript Tutorial - Operators]
<pre>
' single line comment
</pre>

==X: XML==
XML Code<ref>[http://www.tizag.com/xmlTutorial/xmlcomment.php xml comment]</ref> <ref>[http://msdn.microsoft.com/zh-tw/library/ms748250.aspx XML 字元實體和 XAML]</ref>:
<pre>
<!--
	multiple lines
-->
</pre>

References
<references/>

further reading
* [http://blog.csdn.net/haoel/article/details/5782907 五種應該避免的代碼注釋 - 陳皓專欄](簡體)
* [https://en.wikipedia.org/wiki/Comment_(computer_programming) Comment (computer programming) - Wikipedia, the free encyclopedia]
* [https://phpunit.de/manual/current/en/appendixes.annotations.html PHPUnit Manual – Appendix B. Annotations]

[[Category:Web_Dev]] [[Category:Programming]]