Tagged Questions
1
vote
1answer
134 views
How to document unlimited argument parameters?
In PHP you can have a function take an infinite number of arguments like
/**
* Do abc...
*
* @since 1.0
* @param mixed $arg1 Arg description
* @return string ...
2
votes
2answers
152 views
HTML in docblock comments?
In the PEAR standards there is no reference to HTML, if its allowed or not.
http://pear.php.net/manual/en/standards.sample.php
But I see some people use HTML tags like <kbd> and stuff..
So is ...
3
votes
2answers
174 views
Is it recommended to use DocBlock even if I'm not using phpDocumentor?
I'm developing a simple website for a client.
I have read about phpDocumentor and DocBlocks, and I thought that documenting my classes and functions will be very useful.
I'm almost sure I will not ...
7
votes
1answer
339 views
How to document an algorithm properly with sample data?
I am wondering what should an algorithm documentation contain? Can't locate a proper guideline to follow. I have in mind to include
summary of the algorithm
description of the algorithm
flowcharts
...
0
votes
0answers
324 views
printable PHP manual - 'all but the Function Reference section'
My Motivation
I find it easier to learn things by reading 'offline'.
I'd like to lean back and read the narrative part of a paper version of the official php manual.
My Scuppered Plan
My plan was ...
5
votes
6answers
401 views
How complex is the documentation you write?
In a book I'm reading there is a chapter on documentation for your code. The book is about PHP and described some easy methods but also going for some complicated and time consuming methods (xml, xsl) ...
