API, (doxygen,phpdoc,etc) comments in test classes
Posted: Wed May 24, 2006 6:18 pm
Hi,
As a newcomer to the world of unit testing I was wondering if you consider it necessary to write documentation comments in your test classes. I am really unsure about this topic since the methods name in them self describes the test action. However it might be easier to grasp the complete picture in a API documentation generated by Doxygen (my favourite), phpDoc, phpdocumentor, etc.
One of the main reasons I am asking this is because I haven't been able to find any examples of unitesting which have been commented in the source. Another is that writing the test in them self increase the production time and writing heavy documentation on top of that might be a waste of coding time. Although one could argue that unit testing do decrease the overall production time, but that is another discussion....
So what is the grand masters of Unit testing recommendations and or preference?
PS
I have searched the forum, Google and yahoo, but either my search skills need some tuning or there simply isn't any discussion on the topic.
As a newcomer to the world of unit testing I was wondering if you consider it necessary to write documentation comments in your test classes. I am really unsure about this topic since the methods name in them self describes the test action. However it might be easier to grasp the complete picture in a API documentation generated by Doxygen (my favourite), phpDoc, phpdocumentor, etc.
One of the main reasons I am asking this is because I haven't been able to find any examples of unitesting which have been commented in the source. Another is that writing the test in them self increase the production time and writing heavy documentation on top of that might be a waste of coding time. Although one could argue that unit testing do decrease the overall production time, but that is another discussion....
So what is the grand masters of Unit testing recommendations and or preference?
PS
I have searched the forum, Google and yahoo, but either my search skills need some tuning or there simply isn't any discussion on the topic.