[Doc-SIG] epydoc 1.1 release
will
willg@bluesock.org
Thu, 31 Oct 2002 08:38:04 -0600 (CST)
On Thu, 31 Oct 2002, M.-A. Lemburg wrote:
>
> Think of it this way: Java programmers are usually very aware
> of JavaDoc style comments, so switching to epydoc for Python
> programming would probably cause them more trouble due to the
> subtle differences than someone who has never worked in this
> context before.
>From the trenches, I've been doing Java development professionally since
late 98. I've also been doing Python development since early 99 or so.
It took me 2 days to overhaul my Python project's API documentation to use
Epytext with the @param things and I don't have any problem in keeping
Javadoc and Epydoc tags separate in my mind. There are only a handful I
use in each group, so it's pretty easy to keep straight. They could
easily fit on a post-it note that could be stuck to your monitor.
This isn't to say that there doesn't exist a group of folks who will get
confused between the two, but I didn't.
/will