My Naming Conventions

-
Here are the naming conventions I currently use in my projects. I keep questioning myself about them from time to time. Usually I end up changing some point but I'm forcing myself not to do it anymore. Conventions should be a way of reducing developement cost. If you keep changing them you are actually turning them into a money pit. I learned that the most important thing with a naming convention is to stick with it, whatever its definition is.

C#
  • Microsoft guidelines for everything public.
  • Private variables: prefix them with my ie myVariableName. I use this style for both normal variables and winForms controls.

ActionScript

  • Packages, and class members are camelCase.
  • Class names are PascalCase.
  • Private variables: prefix them with _ ie _variableName but I plan to switch this to the same convention I use for C#. That's because prefixing vars with an underscore results in a too low-levelish code for my tastes, and because underscore-prefixed vars as Flex control ids look weird in mxml (I don't want to use different naming conventions for controls and variables).

I thought a little bit about using the underscore style in C#, mainly because you have private vars clearly distinguished from the rest of class members in Intellisense. But again, the resulting code looked too low level.

I also considered using a single letter as a prefix for private vars, ie mMyVariable, but i like using my instead because it often makes the whole variable name sound like a piece of a correct english sentence.

Comments

Post a Comment

Popular posts from this blog

Parallel Gaussian Elimination Using MPI

-
Image
In this project, we had to implement a parallel solver for linear equation systems, using a technique known as Gaussian elimination (GE). As with many other algorithms for solving linear equation systems, GE is performed on the matrix representation of the system, Ax = b, where A is the coefficient matrix and b is the vector of known values. GE works by applying a set of elementary row operations (swapping rows, multiplying a row by a non-zero number, adding a multiple of one row to another) in order to turn the coefficient matrix into upper triangular form. The algorithm has been implemented in C, using the Message Passing Interface (MPI) API. The parallel GE program measured execution times for its four main components: data distribution, Forward Elimination , Pivot row identification, Back substitution. Read the full report here
Read more

Parallel Beam Tracing and Visualization of 200 Million Sonar Points

-
Image
For the final project in the UIC Spring 2013 Parallel Processing Class, I worked with a classmate to optimize our current implementation of a sonar beam tracer used for  The NASA ENDURANCE Project . The beam tracer is used to process the raw data collected by the ENDURANCE AUV in Lake Bonney, Antarctica, and correct sound beam paths using information about the water chemistry. The data is clustered and noise filtered to generate a final 3D Point cloud that can be visualized in our CAVE2 system. The ENDURANCE Sonar data in CAVE2. Photo(c) Lance Long. A lot of corrections and adjustments need to be applied to this data before the final results are acceptable. Some of the corrections derive from the sound speed estimation through the water column, AUV navigation corrections, water level changes and noise filtering thresholds. All this parameters influence the final result, and ideally researchers can tweak them and see the result of their actions in real time. Given the size of
Read more

Flickering 2D transform elements in Chrome: a simple fix

-
This quick post is to point out a fix to an issue I had to deal with a few weeks ago and was caused by a Chrome update. Components with absolute positioning and a 2D CSS transform started flickering when placed inside a scrollable component. A brief search online revealed several people with similar problems, but the suggested fixes were all very different. I tested several of them (including obvious changes to the z order) before finding the one that actually did the trick. What eventually worked for me was adding an empty 3D transform to the same elements with 2D transforms: transform:translate3d(0,0,0); I guess the reason why this works is that it forces elements to be drawn via a different rendering / compositing path than standard 2D elements.
Read more