Development Doc...

Diskussions related to the development of PhpLogCon

Google Ads


Development Doc...

Postby rgerhards » Mon Feb 11, 2008 2:13 pm

Folks,

I expect that we will get quite a bit of development doc in the next weeks. I think about diagrams and text. Question now: how to handle them? Use HTML? Works well with version control, but is somewhat limited. Use a wiki? Needs one and I think is not really good with version control, but has great ability to easily add/change content.

Or embed everything in code comments? If so, how to handle the graphics?

Feedback appreciated,
Rainer
rgerhards
Site Admin
 
Posts: 3806
Joined: Thu Feb 13, 2003 11:57 am

Urgent Question?

  • Pulling out your Hair?
  • Wasting Time and Money?
  • Deadline Approaching?

RE: Development Doc...

Postby mmeckelein » Mon Feb 11, 2008 5:01 pm

I prefer inline code comments using doxygen or phpdoc to create the documentation. Not sure how to handle associated external diagrams but probably a simply link will do the trick.

Michael
mmeckelein
Adiscon Support
 
Posts: 176
Joined: Wed Mar 12, 2003 12:07 pm

RE: Development Doc...

Postby alorbach » Mon Feb 11, 2008 5:17 pm

If it is possible in PHP to use doxygen, I prefer that one too. It's easier to have documentation done ONCE in the code instead of multiple times.
alorbach
Site Admin
 
Posts: 1627
Joined: Thu Feb 13, 2003 11:55 am

RE: Development Doc...

Postby rgerhards » Mon Feb 11, 2008 9:24 pm

I have used doxygen in the past and find it quite useful. To me, this route sounds good. We should try it out tand then make the final decision.

Rainer
rgerhards
Site Admin
 
Posts: 3806
Joined: Thu Feb 13, 2003 11:57 am

Google Ads



Return to Developer's Corner

Who is online

Users browsing this forum: No registered users and 0 guests

cron