Re: pgindent run?

> On Wed, 21 Mar 2001, Bruce Momjian wrote:
>
> >
> > OK, I am going to have dinner and then get started on the pgindent run.
> >
> > I have also noticed we have some comments like:
> >
> > /* ----
> > * one word
> > * ----
> > */
> >
> > that look funny in a few places. I propose:
> >
> > /* one word */
> >
> > to be consistent.
>
> to be consistent with what ... ? isn't:
>
> /* ----------
> * comment
> * ----------
> */
>
> the standard?

Sorry. It has been a while since I studied this. The issue is the
dashes, not the block comments. /* --- is needed for multi-line comment
where you want to preserve the layout, but in other cases, it prevents
comment layout and looks kind of heavy. I eyeball each change to make
sure it is clean so:

/* ---
* test
* ---
*/

becomes the cleaner:

/*
* test
*/

This makes the comment easier to read.

--
Bruce Momjian | http://candle.pha.pa.us
pgman(at)candle(dot)pha(dot)pa(dot)us | (610) 853-3000
+ If your life is a hard drive, | 830 Blythe Avenue
+ Christ can be your backup. | Drexel Hill, Pennsylvania 19026