473,574 Members | 2,588 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Which autodoc tool?

I have been charged with determining a standard for my company for
finding a standard for documenting our code. Actually, I'm new to the
company and have been told that very little is generated so I get to
determine what documentation is acceptable before the current employees
transfer within the company. This means that whatever standard I pick,
I have to be willing to accept the output and then maintain it so my
successor as well.

80~90% of our code is PHP with the remaining balance in Perl. Tools I
have considered so far are:

CHOICE 1: PHPDOC at http://www.phpdoc.de
The original? appears like stagnated several years ago and never grew.
Not really giving it serious consideration unless someone has
compelling reasons otherwise.

CHOICE 2: PHPDocumentor at http://phpdoc.org
What can I say except it appears to the one of the most recommended
tools I have found in research. I am unsure what to expect from it
compared to my third choice.

CHOICE 3: DOXYGEN at http://www.doxygen.org
Been around a long time and doesn't seem like a bad choice. It just
doesn't have the same emphasis on PHP that PHPDocumentor does.

Some of the key points I am looking at personally include:
1) Long term viability of the solution chosen. This could be offset by
the compatibility of the tags with other products.
2) Ease to get existing code documented to the chosen standard
3) Ease to document future code
4) Quality/flexability of the tool chosen

Anyway, which opensource documentation tool do you recommend and why?
Please indicate in responses which you have experience with.

Thanks in advance for the opinions!
Anthony

Jul 17 '05 #1
5 3898
anthony,
Some of the key points I am looking at personally include:
1) Long term viability of the solution chosen. This could be offset by
the compatibility of the tags with other products.
2) Ease to get existing code documented to the chosen standard
3) Ease to document future code
4) Quality/flexability of the tool chosen

Anyway, which opensource documentation tool do you recommend and why?
Please indicate in responses which you have experience with.


Personally I use PHPDocumentor. One because of the support it has with
the tags alone are normally far better than the others. The tags itself
works with the svn/cvs tags as well ie (@version).

The ease of using PHPDocumentor is insanely easy. Although it may take
a little bit to actually get used to it and understand it as most
documenting programs do, but if you are at all familiar with JavaDoc you
will run right into it fine.

To document future code is extremely easy, and even if you deprecate a
function there are tags for that as well! Also tags to show that this
function was available since a certain date.

The quality and flexibility in my mind is amazing, there is only one
thing more that I want is to be able to have inline code examples
generated if more than one exists.

Mike
Jul 17 '05 #2
Mike Willbanks wrote:
anthony,
Some of the key points I am looking at personally include:
1) Long term viability of the solution chosen. This could be offset
by the compatibility of the tags with other products.
2) Ease to get existing code documented to the chosen standard
3) Ease to document future code
4) Quality/flexability of the tool chosen

Anyway, which opensource documentation tool do you recommend and why?
Please indicate in responses which you have experience with.


Personally I use PHPDocumentor. One because of the support it has
with
the tags alone are normally far better than the others. The tags
itself works with the svn/cvs tags as well ie (@version).

The ease of using PHPDocumentor is insanely easy. Although it may
take a little bit to actually get used to it and understand it as most
documenting programs do, but if you are at all familiar with JavaDoc
you will run right into it fine.

To document future code is extremely easy, and even if you deprecate a
function there are tags for that as well! Also tags to show that this
function was available since a certain date.

The quality and flexibility in my mind is amazing, there is only one
thing more that I want is to be able to have inline code examples
generated if more than one exists.


If you use latest version of the Zend Studio it also uses any
PHPDocumentor tags in your code to show help as you are coding, and
also to help with code completion. It's helped to make me a lot more
productive.

--
Chris Hope | www.electrictoolbox.com | www.linuxcdmall.com
Jul 17 '05 #3
Chris,
If you use latest version of the Zend Studio it also uses any
PHPDocumentor tags in your code to show help as you are coding, and
also to help with code completion. It's helped to make me a lot more
productive.


This is the same with PHPEdit

Mike
Jul 17 '05 #4
Mike Willbanks wrote:
Chris,
If you use latest version of the Zend Studio it also uses any
PHPDocumentor tags in your code to show help as you are coding, and
also to help with code completion. It's helped to make me a lot more
productive.


This is the same with PHPEdit


Good to know. Thanks.

--
Chris Hope | www.electrictoolbox.com | www.linuxcdmall.com
Jul 17 '05 #5
an***********@y ahoo.com wrote:
<snip>
Anyway, which opensource documentation tool do you recommend and why?
Please indicate in responses which you have experience with.


We use,
For PHP: PHPDocumentor <http://phpdoc.org>
For VB: VBDOX <http://vbdox.sourcefor ge.net/howto_java.html >
Others: Doxygen

All these tools can produce CHM documents. FWIW, doxygen has lot of
tags and options, but for PHP PHPDocumentor is the de facto.

--
<?php echo 'Just another PHP saint'; ?>
Email: rrjanbiah-at-Y!com Blog: http://rajeshanbiah.blogspot.com/

Jul 17 '05 #6

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

3
2600
by: _andrea.l | last post by:
how to build a interfaces (or web pages) in easy way? how to build a form in easy way? how to automate and create web pages whit a tool? which tool to use to create form for a database? I mean there is a way or a tool which help me to build an interfaces (web pages) to deal with the data in a database ? Tahnk you in advance, Andrea.
38
4776
by: BORT | last post by:
Please forgive me if this is TOO newbie-ish. I am toying with the idea of teaching my ten year old a little about programming. I started my search with something like "best FREE programming language for kids." After MUCH clicking and high-level scanning, I am looking at Python and Forth. Both have advocates that say each is a great...
7
5323
by: SQLDBA | last post by:
I am in the process of evaluating some SQL Performance Monitoring /DBA tool to purchase (For SQL Server 2000). I have the following list of software that I came across and have to finalize which one to recomend for purchase by my company. Quest Central® for SQL Server Performance Center by Embarcadero (dbartisan) Performance analysis by...
3
1696
by: for.fun | last post by:
Hi everybody, I am looking for a XML comparison tool (I do not mean a standard char-by-char diff tool but a tool which understand XML syntax) More precisely, I can have serveral XML structures organized differently. The XML nodes can store the same data but be organized differently => in such a case, I would like the diff tool to tell...
17
3951
by: clintonG | last post by:
I'm using an .aspx tool I found at but as nice as the interface is I think I need to consider using others. Some can generate C# I understand. Your preferences please... <%= Clinton Gallagher http://forta.com/books/0672325667/
6
2423
by: Anastasios Hatzis | last post by:
Hello, I'm working on the light-weight MDA tool pyswarm, http://pyswarm.sourceforge.net/ (it is about a code-generator for Python/PostgreSQL-based software. I plan to add support of UML CASE tools other than the one supported currently. I would like to learn which UML tools you use (if any), preferrably if it comes to modeling a Python...
1
2519
by: JSievers | last post by:
Hallo. A good friend of me develops web suites, for example his own at: www.augenpunkte.de. As you can see there my friend is blind and also he uses a Braille-line to develop these projects. For example his own suite at. But he has a big problem to find out the right colours for his pages and so he asked me for a big list with some colour...
0
1320
by: Georg Scholz | last post by:
(Note: this was intended to be a multi-post, but google was not able to post it also to microsoft.public.dotnet.general, so I'm cross- posting it separately) Hello, I am about to write a SETUP program for a .NET Application, and I am unsure which tool would fit best. I would be very grateful for some help on this topic.
9
19639
by: antonyliu2002 | last post by:
By default, IIS is configured to timeout a session in 20 minutes, which can be changed through the IIS config window. I use InProc sessionState mode. I can also set the session timeout in web.config. So here is my question: If IIS setting has a session timeout value of 20 minutes, but my web.config setting has a session timeout of 30...
0
7808
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main...
0
7732
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language...
0
8243
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that...
0
8101
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the...
0
6456
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then...
0
3742
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in...
0
3754
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
1347
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
0
1062
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.