Notice: Any messages purporting to come from this site telling you that your password has expired, or that you need to verify your details, confirm your email, resolve issues, making threats, or asking for money, are
spam. We do not email users with any such messages. If you have lost your password you can obtain a new one by using the
password reset link.
Due to spam on this forum, all posts now need moderator approval.
Entire forum
➜ ROM
➜ Compiling the server
➜ Help with documenting Rom 2.4b
|
Help with documenting Rom 2.4b
|
It is now over 60 days since the last post. This thread is closed.
Refresh page
| Posted by
| Dralnu
USA (277 posts) Bio
|
| Date
| Sat 24 Nov 2007 05:38 AM (UTC) |
| Message
| It has been ages since I was on here last, and its glad to see things are still going, but enough of that.
I'm trying to work some on a MUD, and having looked over a few codebases, ROM seems to be the best (and one of the smaller ones at 43k lines of code I think) for a start, but right now I'm looking at documenting and commenting the code extensively to make my life a little easier.
Can anyone make some suggestions as to the easiest way to do this, or know of a source where it is already documented? | | Top |
|
| Posted by
| David Haley
USA (3,881 posts) Bio
|
| Date
| Reply #1 on Sun 25 Nov 2007 07:23 AM (UTC) |
| Message
| I'd use Doxygen or NaturalDocs. Doxygen It's a pain to set up the first time, but it lets you add comments somewhat naturally and generates nifty HTML output.
NaturalDocs has more natural syntax, and its output is much prettier but it isn't quite as mature or powerful as Doxygen.
www.doxygen.org
www.naturaldocs.org |
David Haley aka Ksilyan
Head Programmer,
Legends of the Darkstone
http://david.the-haleys.org | | Top |
|
| Posted by
| Dralnu
USA (277 posts) Bio
|
| Date
| Reply #2 on Sun 25 Nov 2007 05:17 PM (UTC) |
| Message
| I have never really used either of those before. What I have been doing is documenting the source code itself via comments and such.
On a sidenote: It seems like NaturalDocs uses an insecure system for many files it uses, making them world-writable.
Just letting you know. | | Top |
|
| Posted by
| David Haley
USA (3,881 posts) Bio
|
| Date
| Reply #3 on Mon 26 Nov 2007 05:34 PM (UTC) |
| Message
|
Quote:
On a sidenote: It seems like NaturalDocs uses an insecure system for many files it uses, making them world-writable.
Mine are neither group nor world writable. It's possible that it inherits permissions from the current directory's settings.
In any case, the nice thing about these systems is that they generate documentation automatically from comments you write for functions, structures and classes. They won't handle inline commenting, though, but arguably you don't need that if you're looking for high-level documentation of the program's structure. |
David Haley aka Ksilyan
Head Programmer,
Legends of the Darkstone
http://david.the-haleys.org | | Top |
|
| Posted by
| Dralnu
USA (277 posts) Bio
|
| Date
| Reply #4 on Mon 26 Nov 2007 11:30 PM (UTC) |
| Message
| I ran doxygen earlier (after I installed it), and went through the docs.
It seems it might do what I want it to. Thanks. | | Top |
|
The dates and times for posts above are shown in Universal Co-ordinated Time (UTC).
To show them in your local time you can join the forum, and then set the 'time correction' field in your profile to the number of hours difference between your location and UTC time.
17,422 views.
It is now over 60 days since the last post. This thread is closed.
Refresh page
![[Go to top]](/images/gototop.gif)
top