1. Principle

1.1 Rationale

Consistent use of approved coding standards reduces the frequency of common run-time errors and promotes maintainability and re-usability.

2. Examples and Discussion

Coding standards promote readability and maintainability---important features for code that is likely to be used over a period of years or reused on other projects and SWE-061 - Coding Standards in NPR 7150.2

1. Restrict the use of dynamic memory allocation to one-time events at system initialization.
2. Use the simplest flow control constructs possible, and avoid the use of “go to”, setjump/longjump.
3. Ensure that all loop constructs have a fixed upper bound, and avoid the use of recursion.
4. Declare data objects at the lowest scope possible.
5. Verify the validity of input parameters at the start of each function, and take appropriate action when inputs are off-nominal. (see also 9.11 Invalid Data Handling and 9.05 Data Interface Integrity design principles)
6. Implement logic to check, and possibly act, on the return value of non-void functions.

A complete set of coding standards typically includes best practices, such as strict language adherence and the use of automated tools to identify problems either at compile time or run time. Language-specific guidance, domain-specific guidance, local standards for code organization and commenting, and standard file header format are often specified as well.

Good coding standards have two things in common: (1) they are concise and relevant enough to be easily used by programmers and quality assurance professionals in their daily activities; and (2) they enable the use of automated code checking. The first is important for obvious reasons. A standard that is too cumbersome will quickly fall into disuse. The second is important because it reduces cost and increases the likelihood that violations that would lead to program errors will be caught before deployment.

A draft version of design principles produced by the Marshall Space Flight Center (MSFC) includes guidance on the use and development of coding standards. In keeping with a “keep it simple” approach, the standard had only six mandatory practices applicable across all programming languages and allows the inclusion of language-specific and project-specific aspects. The mandatory practices strongly overlapped with the minimal set above, and the standard made it clear that the fundamental practices were not to be overridden by language-specific standards, which in turn were not to be overridden by project-specific standards. This tiered approach makes it easier for an organization to implement a basic set of standards that may be tailored on a per-project basis. This approach supports a Capability Maturity Model Integration (CMMI) Level 3 and above organization.

JPL has taken a somewhat different approach. All projects are required to identify the coding standards used in the development, but no specific standard is imposed. An institutionally supported C coding standard is available. This standard is broken down into six levels of compliance, each more rigorous than the next. Projects that use the institutional standard must determine the level of compliance appropriate for their project. Projects are allowed to produce their own standard, use an alternative standard, or tailor the institutional standard. Except for a general provision concerning safety-critical software, there are no restrictions on the standards that may be used. This approach also supports a CMMI Level 3 certification.

Specific coding standards in use include JPL's C Coding Standard

3. Inputs

3.1 NESC inputs

3.2 Other Inputs

4. Resources

4.1 References

5. Lessons Learned

5.1 NASA Lessons Learned

Lessons that appear in the NASA LLIS or Center Lessons Learned Databases.

• Flight Software Deadly Embrace. Lesson Learned 0369:

  Swerefn
  refnum 684

  "During a walk-through of the Galileo Spacecraft System fault protection implementation a possible "deadly embrace" in the flight software was uncovered. A deadly embrace is a continuous software looping operation that may preclude the achievement of an acceptable spacecraft state."