15.05.2013, 18:13
You'd include it so that would give you the directory to where it is stored wouldn't it?
Anyway, I don't think finding it should be your main concern, rather, you should document how the code works, what input it requires, what does it output and how does it process it. With small functions you can remember it, but when you make big, complicated functions or systems you'll lose track. I'm sure you know that already though.
Y_Less documents his code quite well in stuff that he releases (YSI for an example). It gives a good explanation per function on exactly what it does.
What I do myself is, on the top of my main file, I make a small template on how I document functions. This template I then copy over to the top of the function, I usally list the name, parameters, output and what and how it processes it. Code however should speak for itself if you write it well, but from my experience in PAWN you have to use weird hacks and manipulation sometimes to get what you want, so properly explaining what it does will help you in the long run.
Now I'm not very good at this myself, and I often lose track because I use a different variable name for something in another context, which throws me offtrack. This has lead me to actually make a system twice (after I took a break for a month or so) because I thought I never made it. Maybe a good list on what exactly is done, and what functions are linked to that would help.
Anyway, I don't think finding it should be your main concern, rather, you should document how the code works, what input it requires, what does it output and how does it process it. With small functions you can remember it, but when you make big, complicated functions or systems you'll lose track. I'm sure you know that already though.
Y_Less documents his code quite well in stuff that he releases (YSI for an example). It gives a good explanation per function on exactly what it does.
What I do myself is, on the top of my main file, I make a small template on how I document functions. This template I then copy over to the top of the function, I usally list the name, parameters, output and what and how it processes it. Code however should speak for itself if you write it well, but from my experience in PAWN you have to use weird hacks and manipulation sometimes to get what you want, so properly explaining what it does will help you in the long run.
Now I'm not very good at this myself, and I often lose track because I use a different variable name for something in another context, which throws me offtrack. This has lead me to actually make a system twice (after I took a break for a month or so) because I thought I never made it. Maybe a good list on what exactly is done, and what functions are linked to that would help.