[ Date Prev][ Date Next][ Thread Prev][ Thread Next][ Date Index][ Thread Index]
Re: [vsipl++] CLAPACK
- To: Assem Salama <assem@xxxxxxxxxxxxxxxx>
- Subject: Re: [vsipl++] CLAPACK
- From: Mark Mitchell <mark@xxxxxxxxxxxxxxxx>
- Date: Tue, 28 Mar 2006 12:24:28 -0800
Assem Salama wrote:
> +/* define an overloaded function that helps as pas some scalars to the cblas
> + functions. Some cblas functions require the argument to be passed as a
> + pointer when it is complex but by reference otherwise. This makes the
> + defines a little easier to look at */
Here's where I give my standard speech about coding style:
We're building a source product; that means customers will read the
source code. As a result, they will judge us by little details. They
may not understand what the source code does, but they will judge us
based on the bits they do understand -- including comments. The key is
to thing about the source code as if it were a marketing flyer: worry
about it the same way that you'd worry about colors, fonts, and layout
on a brochure.
So, you need to proofread comments carefully. Use complete sentences.
Start every sentence with a capital letter ("define" should be
"Define"). Check spelling: "as pas" should be "us pass". Check
punctuation: you need a period after "to look at".
Similar comments apply to the comment in blaswrap.h.
I know this all seems pedantic; just say nasty things under your breath,
and do it anyhow. :-) :-)
Thanks,
--
Mark Mitchell
CodeSourcery
mark@xxxxxxxxxxxxxxxx
(650) 331-3385 x713
|