Hacker News new | ask | show | jobs
by falcolas 4511 days ago
Of your four points, the first two strike me as generic development skills (knowing what and when to test, knowing what and when to document), and the forth is just reading the docs and following their instructions once. Proper idiomatic language use is probably the only thing you mentioned that is language specific.
2 comments

Writing "proper" javadoc takes time. It has tons of keywords and annotation to make it look consistent like any other "professional and good looking" javadoc out there.

For example: if one is deprecating a method, there are a bunch of proper JavaDoc ways to do this (starting with the @deprecated annotation, not to be confused with another @Deprecated annotation, don't forget to state since which version this method is deprecated, etc etc).

It requires a high level of discipline and knowledge of the javadoc idioms.

http://www.oracle.com/technetwork/java/javase/documentation/...

Occasionally, one have to insert HTML too...

I know C# support similar thing.

Yes and no. Writing test cases can be rather different by language.

Also documentation frameworks may seem identical if you only program in C, C++, and Java. However when you start doing a lot in SQL, Perl, or Python, they start looking very different (and in fact these languages, assuming an SQL that supports COMMENT ON syntax) are more similar than any of them are to C or Java in this regard).

Move from there to TeX or LaTeX and you are in for another big shock.

In short, there are idioms for both test cases and documentation and those are remarkably language-specific.