Comments on: The easy way to keep your code documented http://www.hextudio.com/2007/05/11/the-easy-way-to-keep-your-code-documented/ Thu, 28 May 2009 12:34:01 -0400 http://wordpress.org/?v=2.8.5 hourly 1 By: tioneB http://www.hextudio.com/2007/05/11/the-easy-way-to-keep-your-code-documented/comment-page-1/#comment-133 tioneB Wed, 27 Jun 2007 02:44:58 +0000 http://www.hextudio.com/2007/05/11/the-easy-way-to-keep-your-code-documented/#comment-133 <blockquote>When I start I usually add plenty of comments, but later on it always slows down considerably. </blockquote> hehe yeah me too. I always find myself just trying to make something work, debug, fix, debug, etc.. and then 2-3 days later I'll have to go back and add comments. It's a bad habit I'm trying to break... At least Doxygen helps me not to forget about the function header. That's a start :) My guess would be that since Torque Script is not very far from the C/C syntax, doxygen might work.

When I start I usually add plenty of comments, but later on it always slows down considerably.

hehe yeah me too. I always find myself just trying to make something work, debug, fix, debug, etc.. and then 2-3 days later I’ll have to go back and add comments. It’s a bad habit I’m trying to break… At least Doxygen helps me not to forget about the function header. That’s a start :)

My guess would be that since Torque Script is not very far from the C/C syntax, doxygen might work.

]]> By: Koen Van Baelen http://www.hextudio.com/2007/05/11/the-easy-way-to-keep-your-code-documented/comment-page-1/#comment-131 Koen Van Baelen Tue, 26 Jun 2007 21:28:36 +0000 http://www.hextudio.com/2007/05/11/the-easy-way-to-keep-your-code-documented/#comment-131 Ah, yes, documenting your code! Something I always have to force myself to do. Whenever I start on something I tell myself I'm gonna document everything properly, even though nobody except me will see the code. When I start I usually add plenty of comments, but later on it always slows down considerably. The problem is that in the beginning, your code is easy readable and you know what each line does. Once the project becomes a bit larger, though, it becomes more and more difficult. I wish something like this existed for Torque Game Builder. Ah, yes, documenting your code! Something I always have to force myself to do. Whenever I start on something I tell myself I’m gonna document everything properly, even though nobody except me will see the code. When I start I usually add plenty of comments, but later on it always slows down considerably. The problem is that in the beginning, your code is easy readable and you know what each line does. Once the project becomes a bit larger, though, it becomes more and more difficult. I wish something like this existed for Torque Game Builder.

]]>