[vtk-developers] comments inside BTX ETX + matrix variable naming

[Francois Bertel]

Arguments of functions and methods in VTK start with lowercase. So
it's is not OK. Only the variable member of a class start with an
upper case.

On Sat, Dec 12, 2009 at 9:21 AM, David Doria <daviddoria+vtk at gmail.com> wrote:
> Can I change
>
> //BTX
>  static void Multiply3x3(const double a[9], const double b[9],
>                          double c[9]);
> //ETX
>
> to
>
> //BTX
>  // Description:
>  // Multiplies matrices a and b and stores the result in c according to
>  // c = ab. These matrices are specified as vector indicating a matrix in
>  // row major order. For example, the matrix
>  // [a00 a01 a02]
>  // [a10 a11 a12]
>  // [a20 a21 a22]
>  // should be defined as
>  // double a[9] = {a00, a01, a02, a10, a11, a12, a20, a21, a22};
>  static void Multiply3x3(const double a[9], const double b[9],
>                          double c[9]);
> //ETX
>
> Or will the comment inside the BTX ETX block break something?
>
> Also, I know the rule is to start variable names with lower case
> letters, but does this hold for matrices also? I'd much rather see a
> matrix named 'A' rather than 'a' to conform to mathematical
> notation/practice. Is this ok?
>
> Thanks,
>
> David
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html
>
> Follow this link to subscribe/unsubscribe:
> http://www.vtk.org/mailman/listinfo/vtk-developers
>
>



-- 
François Bertel, PhD  | Kitware Inc. Suite 204
1 (518) 371 3971 x113 | 28 Corporate Drive
                      | Clifton Park NY 12065, USA