When I mean to document this I refer on the first line on the java doc documentation(comments). There are plenty of example in this way in the java API doc. On the other side the documentation is quoted with 70 points, will be a peaty lose some point here.
Rinke, you make a serious assumption here ("Personally, I do not think that Sun is looking at our assignments at this level. I would be surprised if these kind of details will cost you points"), if a documentation lets paces for doubts then you'll lose some points.By example if someone will try to build a test for your class and for this he(she or it) needs to read your source code for this you risk to lose more points. In opposite if you "program with contract" the test builder need only to read the contract and to build the test.
Regards, M [ May 08, 2007: Message edited by: Mihai Radulescu ]
Joined: Apr 06, 2007
Of course, your javadoc comments should mention if your recordnumbers start with 0 or with 1. Of course it is of importance for any other developer who might use your methods, to know if a rec number index starts with 0 or 1. So put in your javadoc at any method using a recnumber as param what your choice was.
What I meant is, that I don't think that Sun will bother if thus choice was startig at 0 or at 1. I even think it is such a tiny issue that it is not worth mentioning in choices.txt.