First to the original poster, there is a way to do this but I would be
asking why you would want to first. With comments being used for annotated
validation for hyrule, to annotated comments for ORM.  If it is just to
purely find code that has been commented out, and needs removing then a
search and look method is perhaps the best option.

Secondly to the argument of TDD and comments. Let me first clear up that
TDD and BDD and tests in general, are there to code coverage our code. So
that there is no unexpected problems in the future, TDD and BDD are
primarily for input and output. That doesn't mean you can't comment on the
tests to say what ever you like to say.

But tests will not cover the likes of known bugs and work around's to
achieve such results, Now I have comments that as stated above are for
annotated validation for hyrule. And although they are tested through TDD,
they are still comments.

Secondly, I have rest / web services that describe what is being returned
from third parties. These are not covered by tests and my part as it is not
my code, but the comments make it very clear what is returned in the body
of the function. In that example the calls to the rest and web services,
are not affecting the final output of the result returned, where tests
cover that. But it does let the developer know that while in there making
changes they can see the expected results and any further outcomes to the
code.

Sorry but I am on the side that comments are a big and necessary thing,
that even I will admit to not doing enough off, but required in more cases
than not.

TDD is not the place to dictate why something was written the way it was
written, its job is to secure and pass on anything that is / might be
passed into that is not expected and cope with a return result. How would
these tests know why I wrote certain code the way that I did, because of
trying to get around a known issue? Would I place that comment in the
tests, no I would not, the comment is related to the way the function
behaves and not if it passes or fails because someone wants to ignore the
comments.


-- 
Regards,
Andrew Scott
WebSite: http://www.andyscott.id.au/
Google+: http://plus.google.com/108193156965451149543


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|
Order the Adobe Coldfusion Anthology now!
http://www.amazon.com/Adobe-Coldfusion-Anthology/dp/1430272155/?tag=houseoffusion
Archive: 
http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:350184
Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm
Unsubscribe: http://www.houseoffusion.com/groups/cf-talk/unsubscribe.cfm

Reply via email to