- Joined
- Jul 10, 2007
- Messages
- 6,306
Just a set of nice looking headers and etc that were developed over a long period of time. I typically just cnp'd these out of existing scripts I wrote, so I thought a template would be nicer =).
If anyone else has any other comment styles they'd like to share, please reply with them and I'll link them in the first post. Also feel free to help improve comment headers ;D.
I'm submitting this because a lot of people struggle with headers. There are many styles from simple ones to more complex ones. This is one that I found to be pretty good for vjass resources.
Just cnp wherever you need and change the stuff to w/e. In lib header, categories you don't need can be removed (not all libraries have a settings area or functions or structs) and others can be added (more modules, structs, etc). Same goes for struct header (not all structs have fields or methods or w/e).
The order I went in was operators, fields, then methods. Of methods, I do constructor/destructor first, then rest of methods.
I hope this helps everyone organize their code more =).
Comment Header Styles
If anyone else has any other comment styles they'd like to share, please reply with them and I'll link them in the first post. Also feel free to help improve comment headers ;D.
I'm submitting this because a lot of people struggle with headers. There are many styles from simple ones to more complex ones. This is one that I found to be pretty good for vjass resources.
Just cnp wherever you need and change the stuff to w/e. In lib header, categories you don't need can be removed (not all libraries have a settings area or functions or structs) and others can be added (more modules, structs, etc). Same goes for struct header (not all structs have fields or methods or w/e).
The order I went in was operators, fields, then methods. Of methods, I do constructor/destructor first, then rest of methods.
I hope this helps everyone organize their code more =).
Comment Header Styles
Last edited: