Sign In
Create Account
Follow Us on Twitter
Subscribe on Youtube
So basically my boss is asking me to find a template or something to document code. He wants somebody to look at my document (without looking at the code) and knowing how to use it.
I googled for a few minutes and found a lot of tutorial on how to comment your code out which is not what I am looking for at all.
If you were documenting code in a Word Document or the like, you would obviously put things in like the name of the function/classes/methods/whatever and the general purpose. But what else should you put in there? Public functions/variables? Examples?
Does anybody have experience doing this or have any example documents I might be able to see?
Thanks in advance!
9 replies to this topic
#1
Posted 14 November 2009 - 03:11 PM
BlaineSch
-
- Members
-
- 2,448 posts
Writes binary right handed and hex left handed
Back to top|
|
|
#2
Guest_Jordan_*
Posted 14 November 2009 - 03:20 PM
Guest_Jordan_*
Guest_Jordan_*
-
- Guests
Are you documenting PHP code and do you use docblock comments? If so, you could just use phpdocumentor.
#3
Posted 14 November 2009 - 03:22 PM
BlaineSch
-
- Members
-
- 2,448 posts
Writes binary right handed and hex left handed
No, I'm trying to make a document like a .doc or something. I'm not trying to improve my comments in my code. I'm trying to make external documentation.
#4
Guest_Jordan_*
Posted 14 November 2009 - 03:40 PM
Guest_Jordan_*
Guest_Jordan_*
-
- Guests
ah, like enduser documentation?
#5
Posted 14 November 2009 - 03:47 PM
BlaineSch
-
- Members
-
- 2,448 posts
Writes binary right handed and hex left handed
Not quite. A more specific example of why I need this is, I am coding a ton of classes each class will probably end up in it's own PHP file and included. Then let's say I quit my job right after I made all the classes, another user who needs to actually code all the pages would simply include my 100+ classes, and when using them not look at any source code but simply look at my documentation.
I don't know the full reason I need this documentation yet. It might be so if they add more features later they won't have to read code. But of course that's why I would add comments... anywho... any input welcome =)
I don't know the full reason I need this documentation yet. It might be so if they add more features later they won't have to read code. But of course that's why I would add comments... anywho... any input welcome =)
#6
Posted 14 November 2009 - 04:52 PM
amrosama
-
- Members
-
- 8,674 posts
Writes binary right handed and hex left handed
wow, thats weird. i have the same issue .
my boss wants the same thing, i ended up making a .doc for each class/ important PHP file.
each one has a description on the class, functions(arguments and return type), and the database tables/fields that may have a relation with that class/file
but i dont think thats a good template since it will need alot of work from me. i can mail you the template i have but its a failure
my boss wants the same thing, i ended up making a .doc for each class/ important PHP file.
each one has a description on the class, functions(arguments and return type), and the database tables/fields that may have a relation with that class/file
but i dont think thats a good template since it will need alot of work from me. i can mail you the template i have but its a failure
yo homie i heard you like one-line codes so i put a one line code that evals a decrypted one line code that prints "i love one line codes"
eval(base64_decode("cHJpbnQgJ2kgbG92ZSBvbmUtbGluZSBjb2Rlcyc7"));
www.amrosama.com | the unholy methods of javascript
#7
Posted 14 November 2009 - 05:52 PM
BlaineSch
-
- Members
-
- 2,448 posts
Writes binary right handed and hex left handed
amrosama said:
wow, thats weird. i have the same issue .
my boss wants the same thing, i ended up making a .doc for each class/ important PHP file.
each one has a description on the class, functions(arguments and return type), and the database tables/fields that may have a relation with that class/file
but i dont think thats a good template since it will need alot of work from me. i can mail you the template i have but its a failure
my boss wants the same thing, i ended up making a .doc for each class/ important PHP file.
each one has a description on the class, functions(arguments and return type), and the database tables/fields that may have a relation with that class/file
but i dont think thats a good template since it will need alot of work from me. i can mail you the template i have but its a failure
Maybe I should just make my own like you did lol I was hoping there might be a standard or some templates I could use so it would look pretty lol
#8
Posted 14 November 2009 - 07:32 PM
amrosama
-
- Members
-
- 8,674 posts
Writes binary right handed and hex left handed
ive googled for a while before doing my own template and i didnt find a thing. just ask your boss for what he wants from the documentation
yo homie i heard you like one-line codes so i put a one line code that evals a decrypted one line code that prints "i love one line codes"
eval(base64_decode("cHJpbnQgJ2kgbG92ZSBvbmUtbGluZSBjb2Rlcyc7"));
www.amrosama.com | the unholy methods of javascript
#9
Posted 14 November 2009 - 07:34 PM
WingedPanther
-
- Moderators
-
- 16,831 posts
A spammer's worst nightmare
For each class, I would list the public methods, the parameters and return types of those methods, etc. I would also provide a general indication of what the purpose of the class is.
My work uses Help & Manual for all documentation. It can then be "compiled" into a variety of formats, including .doc.
My work uses Help & Manual for all documentation. It can then be "compiled" into a variety of formats, including .doc.
#10
Posted 14 November 2009 - 08:06 PM
BlaineSch
-
- Members
-
- 2,448 posts
Writes binary right handed and hex left handed
Well I don't really wanna spend any money on it lol is there a free alternative? I might just make something in Word and throw in those things you guys mentioned.
Thanks for the help.
Thanks for the help.
