Commenting style, was RE: [m-dev.] for review: MLDS backend to do structure reuse and compile time gc

[Ralph Becket]

>From Fergus Henderson on 07/10/2000 15:30:26
> > +ml_gen_unification(deconstruct(Var, ConsId, Args, ArgModes, CanFail,
CanCGC),
> > +	(
> > +			% Note that we can deallocate a cell even if the 
> > +			% unification fails, it is the responsibility of
> > +			% the structure reuse phase to ensure that this
> > +			% is safe.
> > +		{ CanCGC = yes },
> 
> Please don't indent the comments.  The style used throughout the rest
> of that file, and in the examples showing layout of comments in the
> Mercury coding guidelines, is for comments to be intended to the
> same level as the code that they apply to.

I agree that mixing styles within a file is a bad thing.  But IMHO
indented comments make code more legible since they are clearly
separated from the code itself.  Perhaps the guidelines should be
changed. 

--
Ralph Becket      |      MSR Cambridge      |      rbeck at microsoft.com 

--------------------------------------------------------------------------
mercury-developers mailing list
Post messages to:       mercury-developers at cs.mu.oz.au
Administrative Queries: owner-mercury-developers at cs.mu.oz.au
Subscriptions:          mercury-developers-request at cs.mu.oz.au
--------------------------------------------------------------------------