IssueRaiser

Mostly that was an interesting article, but there was one pain point: having to read the parameter list to a routine three (!) times.

Mostly that was an interesting article, but there was one pain point: having to read the parameter list to a routine three (!) times. Honestly, why has no language (few languages?) come up with a scheme yet to put the formal parameters to a routine one per line, with documentation, like so: ... param-name [<type, if specified>] [<documentation>] ... Swap the name and type order for "New Jersey" style languages vs "Swiss" style languages as needed. This is actually how I used to write out my C function headers (Frack K&R layout!), even though we didn't use a doc generator tool such as Doxygen (sp?). Javadoc is only slightly less offensive, naming the parameters twice, due to slavish adherence to the altar of New Jersey formatting. I would love to see "&#x2F;&#x2F;@ description..." after each parameter as an alternate to "* @param name description..." duplication above the parameters. "WET brain-death forever!", I guess.

Posted by Roboprog on Mar 7, 2015, 7:14 PM

Tags

Related issues

Raise real-world problems, find people facing the same issue, and discuss solutions.7,500 issues0 comments

hackernews (E-commerce)

Mostly that was an interesting article, but there was one pain point: having to read the parameter list to a routine three (!) times.

RoboprogMar 7, 2015, 7:14 PM

Mostly that was an interesting article, but there was one pain point: having to read the parameter list to a routine three (!) times. Honestly, why has no language (few languages?) come up with a scheme yet to put the formal parameters to a routine one per line, with documentation, like so: ... param-name [<type, if specified>] [<documentation>] ... Swap the name and type order for "New Jersey" style languages vs "Swiss" style languages as needed. This is actually how I used to write out my C function headers (Frack K&R layout!), even though we didn't use a doc generator tool such as Doxygen (sp?). Javadoc is only slightly less offensive, naming the parameters twice, due to slavish adherence to the altar of New Jersey formatting. I would love to see "&#x2F;&#x2F;@ description..." after each parameter as an alternate to "* @param name description..." duplication above the parameters. "WET brain-death forever!", I guess.

Comments (0)

No comments yet. Start the discussion.

Comment on this issue