I have a custom set of classes I include into most of the apps I make, as I have functions that make certain tasks much easier, such as a tcp client/server class, some bit level manipulation classes and so on. I keep adding new features as I need them.
I find myself sometimes forgetting what I called a certain function so I go check in the header file.
Wondering how everyone here documents their stuff so it's easy to reference later. This includes stuff like commonly used STL functions that you might forget the parameter order or what not. I'm thinking of coding a php web based system where I can search and what not, but wondering if there might be something already out there. I was even thinking, maybe something that scans the code and generates documentation. I always add a comment after my functions, so maybe if there's a program that expects a certain format, then I could always follow it when I code, this way I know my documentation always matches what I coded. For premade functions then it could maybe scan the includes folder or something.
I find myself sometimes forgetting what I called a certain function so I go check in the header file.
Wondering how everyone here documents their stuff so it's easy to reference later. This includes stuff like commonly used STL functions that you might forget the parameter order or what not. I'm thinking of coding a php web based system where I can search and what not, but wondering if there might be something already out there. I was even thinking, maybe something that scans the code and generates documentation. I always add a comment after my functions, so maybe if there's a program that expects a certain format, then I could always follow it when I code, this way I know my documentation always matches what I coded. For premade functions then it could maybe scan the includes folder or something.
Facebook
Twitter