Thursday, November 20, 2008

Documentation

I was looking at this documentation when I realised what java doc needs is hints on expected squences. 

@Example - 
Code example 
@EndExample

and 
@generally follows @thign
@generally is followed by 
@generally first
so 

for f.open
@generally first 
@generally is followed by f.write or f.read

for f.write 
@generally follows f.open
@generally is followed by f.close

f.close
@generally follows f.write or f.read.
@generally ends 




No comments: