From: Brian H. <bri...@ql...> - 2003-04-15 17:45:28
|
On Tue, 15 Apr 2003, Blair Zajac wrote: > > > > > > > - The .mli file now has doc comments! Yay! The .ml file still needs to > > > > be commented. > > > > > > Does it really needs ? > > > I don't especially like comments in source files, they are only needed when > > > you're doing something very difficult to understand... > > > > I have been surprised at what is "intuitively obvious" one day, and > > "completely inexplicable" sometime later. While I don't think there is > > any 'inexplicable' code in this source file, I'm a firm beleiver in better > > safe than sorry. > > Agreed. I can't believe there's a suggestion to remove documentation :) Actually, it's a suggestion not to add comments. They aren't there yet. I fully intend to add them (see above comments)- at least some of them- while I still remember how it works. Brian |