phpdoc... what?

[L4DD13]

Hi guys,

What is the purpose of phpdoc?

Thanks

[decowski]

Generating code documentation from comments. You comment your code using a modified comment syntax and special phpdoc tags:

/**
 * Some func
 *
 * Longer description
 *
 * @param string $in Input string
 * @return string Output string
 */
function do_something($in) {
    // do something
    return $out;
} 

and then run phpdoc to generate a documentation in various formats (PDF, HTML, Windows Help, and many more).

[AnthonySterling]

It also allows the better IDEs out there to provide type hinting as you code.

Very useful.

[decowski]

It also allows the better IDEs out there to provide type hinting as you code.

Good point. I'm using phpDesigner and it parses phpdoc comments and when you place the cursor at a call to a function/method that has its phpdoc block then it displays its description, parameters and return. Very helpful.

[L4DD13]

ah, thanks guys.