Version française
Home     About     Download     Resources     Contact us    
Browse thread
Re: [Caml-list] Re: [Caml-announce] OCamldoc
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: -- (:)
From: Benjamin C. Pierce <bcpierce@s...>
Subject: Re: [Caml-list] Re: [Caml-announce] OCamldoc
> I think you missed the point of Jerome's suggestion, which was (** ...
> *) vs. (* ... **).  (Either that, or I missed his point...).  So my
> variant was to show the difference at the start of each comment, where
> it would be more immediate.

Aha -- sorry, I did miss the point.  So I'd like to make another a
variant proposal... :-)

  - The comment is before the element:
        (** fun 1 *)
        val f : t
        (** fun 2 *)
        val g : u

  - The comment is after the element:
        val f : t
          (** fun 1 *)
        val g : u
          (** fun 2 *)

  - The comment is on the same line as the element:
        val f : t   (** fun 1 *)
        val g : u   (** fun 2 *)
    (Most useful for record fields, probably.)

I.e., *one* kind of (not very) funny comment marker, plus using the
indentation to decide whether the comment binds to the expression before
or after:

      if the comment is on a line by itself, 
      then if its indentation is the same as the following (non-comment) line
           then it goes with the following
           else it goes with the preceding
      else it goes with the line it's on.

  -- B

-----------------------------------------------------------------------------
BENJAMIN C. PIERCE
Associate Prof., Computer & Information Science        bcpierce@cis.upenn.edu
University of Pennsylvania                                    +1 215 898-2012
200 South 33rd St.                                       Fax: +1 215 898-0587
Philadelphia, PA 19104, USA                http://www.cis.upenn.edu/~bcpierce
-----------------------------------------------------------------------------







-------------------
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