note 54296 added to language.basic-syntax.comments
| From: | hcderaad at wanadoo dot nl | Date: | Wed, 29 Jun 2005 20:51:51 +0000 |
| Subject: | note 54296 added to language.basic-syntax.comments | ||
| Groups: | php.notes | ||
| Request: | Send a blank email to php-notes+get-91161@lists.php.net to get a copy of this message | ||
Comments in PHP can be used for several purposes, a very interesting one being that you can generate
API documentation directly from them by using PHPDocumentor (http://www.phpdoc.org/).
Therefor one has to use a JavaDoc-like comment syntax (conforms to the DocBook DTD), example:
<?php
/**
* The second * here opens the DocBook commentblock, which could later on<br>
* in your development cycle save you a lot of time by preventing you having to rewrite<br>
* major documentation parts to generate some usable form of documentation.
*/
?>
Some basic html-like formatting is supported with this (ie <br> tags) to create something of a
layout.
----
Manual Page -- http://www.php.net/manual/en/language.basic-syntax.comments.php
Edit -- http://master.php.net/manage/user-notes.php?action=edit+54296
Delete: added to the manual -- http://master.php.net/manage/user-notes.php?action=delete+54296&report=yes&reason=added+to+the+manual
Delete: bad code -- http://master.php.net/manage/user-notes.php?action=delete+54296&report=yes&reason=bad+code
Delete: spam -- http://master.php.net/manage/user-notes.php?action=delete+54296&report=yes&reason=spam
Delete: useless -- http://master.php.net/manage/user-notes.php?action=delete+54296&report=yes&reason=useless
Delete: non-english -- http://master.php.net/manage/user-notes.php?action=delete+54296&report=yes&reason=non-english
Delete: other reasons -- http://master.php.net/manage/user-notes.php?action=delete+54296&report=yes
Reject -- http://master.php.net/manage/user-notes.php?action=reject+54296&report=yes
Search -- http://master.php.net/manage/user-notes.php