The next step could be to document function parameters inline.
That's where my experiment with Exception specifications led
me to. Instead of manually listing "Throws:" and "Params:" you
would add the comments right after the respective
exception/parameter. The benefit in terms of "reducing
dependencies":

1) DRY: You don't have to keep the Params: list in mind when
you add or rename a parameter. It will also be more obvious to
add a comment to a new parameter when the others have them.

2) You can document dummy parameters without giving them a
name first.

-- 
Marco

Reply via email to