2
votes
1answer
245 views

How to find classes that use certain DB tables

Problem: I'm asked to prepare a document where all our DB tables are listed and I'm supposed to list all Controllers that uses these DB tables for read and another list for Controllers that do write ...
0
votes
1answer
88 views

Maturity User Guide, Documentation and Ease-of-learning PHP-framework

I'm at the very start of a longtime running project with continual development. Because of that I'm hoping to make a good decision in which Framework will be right for this. Previously I've worked ...
1
vote
1answer
71 views

how to map controllers , models, and views as a todo list

Before starting on a current project I was wondering if there is a terminology for what I am planning on doing? Basically what I want to do is map out every object in layers such as all the ...
1
vote
1answer
331 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
274 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
291 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
653 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 ...
5
votes
6answers
503 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) ...