help/html/commenting_code.htm - gerrit/www.eclipse.org/pdt - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <meta name="generator" content="Adobe RoboHelp 8">
 <title>Code Commenting</title>
 <link rel="StyleSheet" href="default.css" type="text/css">
 <style type="text/css">
 <!--
 body { border-left-style:None;
 border-right-style:None;
 border-bottom-style:None;
 background-color:Transparent;
 border-top-style:None; }
 -->
 </style>
 <style type="text/css">
 <!--
 body { border-left-style:None;
 border-right-style:None;
 border-bottom-style:None;
 background-color:Transparent;
 border-top-style:None; }
 -->
 </style>
 <script type="text/javascript" language="JavaScript">
 //<![CDATA[
 function reDo() {
   if (innerWidth != origWidth || innerHeight != origHeight)
      location.reload();
 }
 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {
 	origWidth = innerWidth;
 	origHeight = innerHeight;
 	onresize = reDo;
 }
 onerror = null;
 //]]>
 </script>
 <style type="text/css">
 <!--
 div.WebHelpPopupMenu { position:absolute;
 left:0px;
 top:0px;
 z-index:4;
 visibility:hidden; }
 p.WebHelpNavBar { text-align:right; }
 -->
 </style>
 <script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>
 <script type="text/javascript" language="javascript" src="whver.js"></script>
 <script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>
 <script type="text/javascript" language="javascript1.2" src="whutils.js"></script>
 <script type="text/javascript" language="javascript1.2" src="whlang.js"></script>
 <script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>
 <script type="text/javascript" language="javascript1.2">//<![CDATA[
 <!--
 if (window.gbWhTopic)
 {
 	var strUrl = document.location.href;
 	var bc = 0;
 	var n = strUrl.toLowerCase().indexOf("bc-");
 	if(n != -1)
 	{
 		document.location.href = strUrl.substring(0, n);
 		bc = strUrl.substring(n+3);
 	}

 	if (window.setRelStartPage)
 	{
 	addTocInfo("Concepts\nCode Commenting");
 addAvenueInfo("Concepts","code_folding.htm","hover_support.htm");

 	}

 	document.write("<p style=\"text-align:left\"> ");
 AddMasterBreadcrumbs("ide_help.htm", "", "&gt;", "Home", "pdt_table_of_contents.htm");
 document.write("<a href=\"concepts.htm\">Concepts<\/a> &gt; Code Commenting<\/p>");


 	if (window.setRelStartPage)
 	{
 	setRelStartPage("ide_help.htm");

 		autoSync(0);
 		sendSyncInfo();
 		sendAveInfoOut();
 	}

 }
 else
 	if (window.gbIE4)
 		document.location.reload();
 //-->
 //]]></script>
 </head>

 <body leftmargin="5" topmargin="5" rightmargin="5" bottommargin="5"><script type="text/javascript" language="javascript1.2">//<![CDATA[
 <!--
 if (window.writeIntopicBar)
 	writeIntopicBar(4);
 //-->
 //]]></script>
 <div style="width: 100%; position: relative;" id="header">


  <p align="right"><a
 	 title="Documentation Survey" href="http://spreadsheets.google.com/viewform?formkey=dC1scEswTjFia2tDQ3Y5TVJBbkNQcWc6MQ">Documentation
 	 Survey</a>
 	 | <a href="javascript:crlf=&quot;&quot;;h=location.href;t=document.title;e = &quot;&quot; + (window.getSelection ? window.getSelection() : document.getSelection ? document.getSelection() : document.selection.createRange().text); if (e!=null) location=&quot;mailto:documentation@zend.com&quot; + &quot;?Subject= Feedback on PDT for page &quot; + escape(t) + &quot;&amp;Body=&quot; + escape(e).replace(/ /g, &quot;+&quot;) + crlf + &quot; &quot;; void 0"><span
 	 style="background-color: #ffffff;">Submit Documentation</span><span
 	 style="background-color: #ffffff;"> Feedback</span></a><span
 	 style="background-color: #ffffff;"></span><span style="background-color: #ffffff;">
 	 </span><span style="background-color: #ffffff;">|
 	 </span><span
 	 style="background-color: #ffffff;"><a title="View Latest Version and Get PDF Online"
 											 href="http://www.zend.com/en/resources/zend-documentation/"
 											 target="_blank">View Latest
 	 Version and Get PDF Online</a></span></p>
 </div>


 <h1>Code Commenting</h1>
 <p>Commenting your code involves adding characters (normally slashes and
  stars) which mark certain areas of code as 'comments'.</p>
 <p>Comments are used for reference information only and will not be run
  as part of your code. It is good programming practice to comment all functions,
  classes and methods in your code. This helps both the developer and others
  who might look at the code to understand its purpose.</p>
 <p>&#160;</p>
 <p>Comments can be either single line or multi-lined:</p>
 <ul type="square">
 	<li><p>Single lined comments will have the following format:</p></li>
 </ul>
 <p class="code" style="margin-left: 40px;">// This is a single line comment.</p>
 <ul type="square">
 	<li><p>Multi-lined comments will have the following format:</p></li>
 </ul>
 <p class="code" style="margin-left: 40px;">/* This is</p>
 <p class="code" style="margin-left: 40px;">a comment</p>
 <p class="code" style="margin-left: 40px;">on multiple</p>
 <p class="code" style="margin-left: 40px;">lines</p>
 <p class="code" style="margin-left: 40px;">*/</p>
 <div>
 <p class="Note">Note:</p>
 <p class="NoteText">Code Commenting
  will also be available for JavaScript elements if JavaScript support was
  enabled for the project. See <a href="enabling_javascript_support_in_php_projects.htm">Enabling
  JavaScript Support in PHP Projects</a> for more information. </p>
 </div>
 <table cellspacing="0" width="100%">
 	<col style="width: 7.093%;">
 	<col style="width: 92.907%;">
 	<tr style="vertical-align: top;">
 		<td style="width: 7.093%; padding-right: 10px; padding-left: 10px;"><p
 			 style="font-size: 6pt;">&#160;</p></td>
 		<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p>&#160;</p></td>
 	</tr>
 	<tr style="vertical-align: top;">
 		<td style="width: 7.093%; padding-right: 10px; padding-left: 10px;"><p
 			 style="font-size: 6pt;"><img src="link_icon.png" alt="link_icon.png" style="border: none;" width="32" height="40" border="0"></p></td>
 		<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
 			 style="font-weight: bold;">Related Links:</p>
 		<p><a href="how_to_comment_and_uncomment_php_code.htm">Adding
 		 Comments</a></p>
 		<p><a href="phpdoc_comments.htm">phpDoc Comments</a>
 		 </p>
 		<p><a href="commenting_php_docblocks.htm">Commenting PHP DocBlocks</a>
 		 </p></td>
 	</tr>
 	<tr style="vertical-align: top;">
 		<td style="width: 7.093%; padding-right: 10px; padding-left: 10px;"><p
 			 style="font-size: 6pt;">&#160;</p></td>
 		<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p>&#160;</p></td>
 	</tr>
 </table>
 <div style="width: 100%; position: relative;" id="footer">

  <p style="text-decoration: underline; "
 										 align="center">PHP Development
 	 Tools</p>


 </div>
 <script type="text/javascript" language="javascript1.2">//<![CDATA[
 <!--
 if (window.writeIntopicBar)
 	writeIntopicBar(0);

 highlightSearch();
 //-->
 //]]></script>
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
	<html>
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
	<meta name="generator" content="Adobe RoboHelp 8">
	<title>Code Commenting</title>
	<link rel="StyleSheet" href="default.css" type="text/css">
	<style type="text/css">
	<!--
	body { border-left-style:None;
	border-right-style:None;
	border-bottom-style:None;
	background-color:Transparent;
	border-top-style:None; }
	-->
	</style>
	<style type="text/css">
	<!--
	body { border-left-style:None;
	border-right-style:None;
	border-bottom-style:None;
	background-color:Transparent;
	border-top-style:None; }
	-->
	</style>
	<script type="text/javascript" language="JavaScript">
	//<![CDATA[
	function reDo() {
	if (innerWidth != origWidth \|\| innerHeight != origHeight)
	location.reload();
	}
	if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {
	origWidth = innerWidth;
	origHeight = innerHeight;
	onresize = reDo;
	}
	onerror = null;
	//]]>
	</script>
	<style type="text/css">
	<!--
	div.WebHelpPopupMenu { position:absolute;
	left:0px;
	top:0px;
	z-index:4;
	visibility:hidden; }
	p.WebHelpNavBar { text-align:right; }
	-->
	</style>
	<script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>
	<script type="text/javascript" language="javascript" src="whver.js"></script>
	<script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>
	<script type="text/javascript" language="javascript1.2" src="whutils.js"></script>
	<script type="text/javascript" language="javascript1.2" src="whlang.js"></script>
	<script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>
	<script type="text/javascript" language="javascript1.2">//<![CDATA[
	<!--
	if (window.gbWhTopic)
	{
	var strUrl = document.location.href;
	var bc = 0;
	var n = strUrl.toLowerCase().indexOf("bc-");
	if(n != -1)
	{
	document.location.href = strUrl.substring(0, n);
	bc = strUrl.substring(n+3);
	}

	if (window.setRelStartPage)
	{
	addTocInfo("Concepts\nCode Commenting");
	addAvenueInfo("Concepts","code_folding.htm","hover_support.htm");

	}

	document.write("<p style=\"text-align:left\"> ");
	AddMasterBreadcrumbs("ide_help.htm", "", ">", "Home", "pdt_table_of_contents.htm");
	document.write("<a href=\"concepts.htm\">Concepts<\/a> > Code Commenting<\/p>");


	if (window.setRelStartPage)
	{
	setRelStartPage("ide_help.htm");

	autoSync(0);
	sendSyncInfo();
	sendAveInfoOut();
	}

	}
	else
	if (window.gbIE4)
	document.location.reload();
	//-->
	//]]></script>
	</head>

	<body leftmargin="5" topmargin="5" rightmargin="5" bottommargin="5"><script type="text/javascript" language="javascript1.2">//<![CDATA[
	<!--
	if (window.writeIntopicBar)
	writeIntopicBar(4);
	//-->
	//]]></script>
	<div style="width: 100%; position: relative;" id="header">


	<p align="right"><a
	title="Documentation Survey" href="http://spreadsheets.google.com/viewform?formkey=dC1scEswTjFia2tDQ3Y5TVJBbkNQcWc6MQ">Documentation
	Survey</a>
	\| <a href="javascript:crlf="";h=location.href;t=document.title;e = "" + (window.getSelection ? window.getSelection() : document.getSelection ? document.getSelection() : document.selection.createRange().text); if (e!=null) location="mailto:documentation@zend.com" + "?Subject= Feedback on PDT for page " + escape(t) + "&Body=" + escape(e).replace(/ /g, "+") + crlf + " "; void 0"><span
	style="background-color: #ffffff;">Submit Documentation</span><span
	style="background-color: #ffffff;"> Feedback</span></a><span
	style="background-color: #ffffff;"></span><span style="background-color: #ffffff;">
	</span><span style="background-color: #ffffff;">\|
	</span><span
	style="background-color: #ffffff;"><a title="View Latest Version and Get PDF Online"
	href="http://www.zend.com/en/resources/zend-documentation/"
	target="_blank">View Latest
	Version and Get PDF Online</a></span></p>
	</div>


	<h1>Code Commenting</h1>
	<p>Commenting your code involves adding characters (normally slashes and
	stars) which mark certain areas of code as 'comments'.</p>
	<p>Comments are used for reference information only and will not be run
	as part of your code. It is good programming practice to comment all functions,
	classes and methods in your code. This helps both the developer and others
	who might look at the code to understand its purpose.</p>
	<p> </p>
	<p>Comments can be either single line or multi-lined:</p>
	<ul type="square">
	<li><p>Single lined comments will have the following format:</p></li>
	</ul>
	<p class="code" style="margin-left: 40px;">// This is a single line comment.</p>
	<ul type="square">
	<li><p>Multi-lined comments will have the following format:</p></li>
	</ul>
	<p class="code" style="margin-left: 40px;">/* This is</p>
	<p class="code" style="margin-left: 40px;">a comment</p>
	<p class="code" style="margin-left: 40px;">on multiple</p>
	<p class="code" style="margin-left: 40px;">lines</p>
	<p class="code" style="margin-left: 40px;">*/</p>
	<div>
	<p class="Note">Note:</p>
	<p class="NoteText">Code Commenting
	will also be available for JavaScript elements if JavaScript support was
	enabled for the project. See <a href="enabling_javascript_support_in_php_projects.htm">Enabling
	JavaScript Support in PHP Projects</a> for more information. </p>
	</div>
	<table cellspacing="0" width="100%">
	<col style="width: 7.093%;">
	<col style="width: 92.907%;">
	<tr style="vertical-align: top;">
	<td style="width: 7.093%; padding-right: 10px; padding-left: 10px;"><p
	style="font-size: 6pt;"> </p></td>
	<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p> </p></td>
	</tr>
	<tr style="vertical-align: top;">
	<td style="width: 7.093%; padding-right: 10px; padding-left: 10px;"><p
	style="font-size: 6pt;"><img src="link_icon.png" alt="link_icon.png" style="border: none;" width="32" height="40" border="0"></p></td>
	<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
	style="font-weight: bold;">Related Links:</p>
	<p><a href="how_to_comment_and_uncomment_php_code.htm">Adding
	Comments</a></p>
	<p><a href="phpdoc_comments.htm">phpDoc Comments</a>
	</p>
	<p><a href="commenting_php_docblocks.htm">Commenting PHP DocBlocks</a>
	</p></td>
	</tr>
	<tr style="vertical-align: top;">
	<td style="width: 7.093%; padding-right: 10px; padding-left: 10px;"><p
	style="font-size: 6pt;"> </p></td>
	<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p> </p></td>
	</tr>
	</table>
	<div style="width: 100%; position: relative;" id="footer">

	<p style="text-decoration: underline; "
	align="center">PHP Development
	Tools</p>


	</div>
	<script type="text/javascript" language="javascript1.2">//<![CDATA[
	<!--
	if (window.writeIntopicBar)
	writeIntopicBar(0);

	highlightSearch();
	//-->
	//]]></script>
	</body>
	</html>