DocBlock
/** * Short Description * * Long Description * * @tag I am a tag named "tag" * @other And I am a tag named "other" */
In the example above you see how a DocBlock looks like. It contains all relevant information to understand the concept of DocBlock in CSSDOC.
DocBlock is a term and concept originally used by the PHPDocumentor Project which borrowed it from the javadoc tool. You can get in-depth information about the concepts of DocBlock there. Since it is used in the PHP and Java world for Programming needs, CSSDOC uses only a small part of its concept and features.
In the javadoc documentation, DocBlocks are called Documentation comments or doc comments. They are defined as "special comments in the Java source code that are delimited by the /** ... */ delimiters." ( Source)
Tools supporting DocBlock comments
- PHPDocumentor
- Javadoc tool
- PECL DocBlock Package and PEAR PHP_Parser_DocblockParser Package by Greg Beaver
