15.05.2013, 17:22
I've been working on a server for about a year now, and it didn't get very far for many reasons. Low motivation, bad layout, poor coding standards and practically no documentation at all are but a few.
I've definately improved since making those topics, and definately see the advantages of using many included files as opposed to having everything in a single .pwn file (that's just stupid and I realise so now!).
I made this topic to discuss with you all (especially those with experience with major projects) how to go about documenting your stuff. I had a short conversation with Gamer_Z a few days ago about this, and he referred me to this: http://www.stack.nl/~dimitri/doxygen/ It seems way too much for a SA-MP server though. I think it would confuse me more than help me.
My main 'concern' is this: I create a function, for example, CreateDoubleRainbow(), and it's in some file in my server files, for example /scripts/core/objects/blah/dir/lol/rainbows.inc
If I want to edit that function 3 months down the line - how do I find it? I clearly need to document WHERE it is, WHAT it does and HOW to use it, but I'm not too sure how to go about that. At one point I thought of creating a wiki for it, but that seems a bit weird for some reason, not really the done thing.
Discuss!
I've definately improved since making those topics, and definately see the advantages of using many included files as opposed to having everything in a single .pwn file (that's just stupid and I realise so now!).
I made this topic to discuss with you all (especially those with experience with major projects) how to go about documenting your stuff. I had a short conversation with Gamer_Z a few days ago about this, and he referred me to this: http://www.stack.nl/~dimitri/doxygen/ It seems way too much for a SA-MP server though. I think it would confuse me more than help me.
My main 'concern' is this: I create a function, for example, CreateDoubleRainbow(), and it's in some file in my server files, for example /scripts/core/objects/blah/dir/lol/rainbows.inc
If I want to edit that function 3 months down the line - how do I find it? I clearly need to document WHERE it is, WHAT it does and HOW to use it, but I'm not too sure how to go about that. At one point I thought of creating a wiki for it, but that seems a bit weird for some reason, not really the done thing.
Discuss!