Comments on: Doc Blocks Rock! http://www.fornax.net/2007/04/doc-blocks-rock/ Is Don. Is Good. Wed, 10 Mar 2010 23:30:19 +0000 http://wordpress.org/?v=2.9.2 hourly 1 By: Travis Swicegood http://www.fornax.net/2007/04/doc-blocks-rock/comment-page-1/#comment-35 Travis Swicegood Sun, 15 Apr 2007 22:08:31 +0000 http://www.fornax.net/2007/04/doc-blocks-rock/#comment-35 One thing I would add here is that the unit tests - when following a TDD or test-first approach - answer the question "what should the code do?" Using a contrived example, if you have a function called add() and your test verifies that 2 + 2 equals 4, the the function body should be: return 2 + 2; That said, I do know several developers who's mind works better writing out a quick docblock to start coding. It start their mind on the "oh wait, what about ...?" path. It's what works best for (the rhetorical) you. I tend toward tests because that's something I can reproduce later. One thing I would add here is that the unit tests – when following a TDD or test-first approach – answer the question “what should the code do?” Using a contrived example, if you have a function called add() and your test verifies that 2 + 2 equals 4, the the function body should be: return 2 + 2;

That said, I do know several developers who’s mind works better writing out a quick docblock to start coding. It start their mind on the “oh wait, what about …?” path. It’s what works best for (the rhetorical) you. I tend toward tests because that’s something I can reproduce later.

]]>