From mboxrd@z Thu Jan 1 00:00:00 1970 Received: (from majordomo@localhost) by pauillac.inria.fr (8.7.6/8.7.3) id QAA25245; Tue, 9 Oct 2001 16:27:25 +0200 (MET DST) X-Authentication-Warning: pauillac.inria.fr: majordomo set sender to owner-caml-list@pauillac.inria.fr using -f Received: from nez-perce.inria.fr (nez-perce.inria.fr [192.93.2.78]) by pauillac.inria.fr (8.7.6/8.7.3) with ESMTP id QAA25228 for ; Tue, 9 Oct 2001 16:27:24 +0200 (MET DST) Received: from fledge.watson.org (fledge.watson.org [204.156.12.50]) by nez-perce.inria.fr (8.11.1/8.10.0) with ESMTP id f99ERM922369; Tue, 9 Oct 2001 16:27:22 +0200 (MET DST) Received: from localhost (patrick@localhost) by fledge.watson.org (8.11.6/8.11.5) with SMTP id f99ER0J11858; Tue, 9 Oct 2001 10:27:00 -0400 (EDT) (envelope-from patrick@watson.org) Date: Tue, 9 Oct 2001 10:26:59 -0400 (EDT) From: Patrick M Doane To: Maxence Guesdon cc: caml-list@inria.fr Subject: Re: [Caml-list] Re: [Caml-announce] OCamldoc In-Reply-To: <3BC3343C.8040704@inria.fr> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: owner-caml-list@pauillac.inria.fr Precedence: bulk On Tue, 9 Oct 2001, Maxence Guesdon wrote: > > Besides, I think it is usually more readable to put the comment after > > the element. Indeed, you often search for an element (by name), and > > then read the corresponding comment. > > I agree that, in .mli files for example, i prefer to have the comment > after the definition, but for consistency between .ml and .mli files, > the comment-before-definition way was chosen. Placing comments after the definition is standard O'Caml practice. It would be a shame to lose this as most source code already follows this convention. I also don't understand the need for consistency between the .ml and .mli files. The documentation effort for an implementation is a very different task than for its interface. I agree that this may make things more difficult, but the O'Caml community has a long-standing tradition of compatibility with previous design choices. Comments after definition in the .mli file is a choice that most of us, including yourself, prefer anyways. Patrick ------------------- Bug reports: http://caml.inria.fr/bin/caml-bugs FAQ: http://caml.inria.fr/FAQ/ To unsubscribe, mail caml-list-request@inria.fr Archives: http://caml.inria.fr