Nasal Style Guide

From wiki.flightgear.org

Jump to: navigation, search
This article is a stub. You can help the wiki by expanding it..


Work in progress
This article or section will be worked on in the upcoming hours or days.
See history for the latest developments.


This page is meant to collect guidelines related to writing Nasal code for use in FlightGear, it is inspired by [1] and should eventually provide a comprehensive list of stylistic recommendations concerning Nasal, so that contributors can refer to this guide in order to more easily create and provide Nasal related contributions in suitable shape and form.

As of 05/2009, this is work in progress. Initially, most guidelines will come from related mailing list postings, as well as be based on conventions as reflected by existing Nasal Modules in the FlightGear base package, which pretty much define the standard for Nasal use in FlightGear.

Contents

Variable Declarations

Should always make use of the 'var' keyword

Naming Conventions

Functions

Hashes

Constructors

Should be named "new"

Destructors

Should be named "del"

Methods