TalkPHP - View Single Post

Ross · 09-03-2008, 12:19 PM

In Java, Javadoc (the equivalent of PHPdoc) uses /** */ comments for Javadoc comments and /* */ for plain comments.

I tend to use a /** */ when doing a multiline comment, a /* */ on an line comment detailing a section of code and a // when detailing the next few lines.

For example:

PHP Code:


			
/**
 * Page-level docblock
 */

/* Editing the file */

// Open, write and close
$f = fopen('file.html', 'w');
fwrite($f, 'tets');
fclose($f);

09-03-2008, 12:19 PM	#3 (permalink)
Ross The Contributor Join Date: Jan 2008 Location: England, UK Posts: 83 Thanks: 3	In Java, Javadoc (the equivalent of PHPdoc) uses `/** /` comments for Javadoc comments and `/ /` for plain comments. I tend to use a `/* /` when doing a multiline comment, a `/ /` on an line comment detailing a section of code and a `//` when detailing the next few lines. For example: PHP Code: `/* * Page-level docblock / / Editing the file */ // Open, write and close $f = fopen('file.html', 'w'); fwrite($f, 'tets'); fclose($f);`