[vsipl++] CLAPACK

Mark Mitchell mark at codesourcery.com
Tue Mar 28 20:24:28 UTC 2006


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 at codesourcery.com
(650) 331-3385 x713



More information about the vsipl++ mailing list