0

Hello! Currently I am working on a PHP project on my own that is slowly growing, before I really get it out there I want to begin working on some documentation. It's just that I'm unsure on how documentation is usually created, best practices on writing it, and how it should be organized. Wasn't sure where this should be posted, but thanks for any suggestions!

4
Contributors
4
Replies
18
Views
4 Years
Discussion Span
Last Post by diafol
1

Hello! Currently I am working on a PHP project on my own that is slowly growing, before I really get it out there I want to begin working on some documentation.

What mention pritaeas is a good choice. I was about to post it too.

You can read this and get an idea how to write it:

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/li_phpDocumentor.html

http://www.weberdev.com/ViewArticle/Writing-Self-Documenting-PHP-Code

After you write the documentation find a software to display the doc.

You can look at this:

http://www.docblox-project.org/ (which is what pritaeas post)

I don't write docs this is the closes format I have used (you can look at this):

http://pear.php.net/manual/en/package.php.php-codesniffer.coding-standard-tutorial.php

It's kinda neat.

Edited by LastMitch: grammer

0

Okay thanks, I will take a look and try to figure out what's going on. Especially the link pritaeas gave, I'm still trying to figure out what it does and how to install it lol.

This topic has been dead for over six months. Start a new discussion instead.
Have something to contribute to this discussion? Please be thoughtful, detailed and courteous, and be sure to adhere to our posting rules.