bannera

Book A.
Introduction

Book B.
7150 Requirements Guidance

Book C.
Topics

Tools,
References, & Terms

SPAN
(NASA Only)

SWE-061 - Coding Standards

1. Requirements

3.3.2 The project shall ensure that software coding methods, standards, and/or criteria are adhered to and verified.

1.1 Notes

NPR 7150.2, NASA Software Engineering Requirements, does not include any notes for this requirement.

1.2 Applicability Across Classes

Classes F and G are labeled with "X (not OTS)." This means that this requirement does not apply to off-the-shelf software for these classes.

Class

  A_SC 

A_NSC

  B_SC 

B_NSC

  C_SC 

C_NSC

  D_SC 

D_NSC

  E_SC 

E_NSC

     F      

     G      

     H      

Applicable?

   

   

   

   

   

   

   

   

   

   

    X

    X

   

Key:    A_SC = Class A Software, Safety Critical | A_NSC = Class A Software, Not Safety Critical | ... | - Applicable | - Not Applicable
X - Applicable with details, read above for more | P(C) - P(Center), follow center requirements or procedures

2. Rationale

NASA programs and projects have multiyear life cycle times. Often the software personnel who develop the original software work products move on to other projects. These developers are then backfilled on the team by other developers for the remainder of development, for operations, maintenance, and disposal phases of the life cycle. This personnel turnover process may occur several times during the project's life cycle. The use of uniform software coding methods, standards, and/or criteria ensures uniform coding practices, reduces errors through safe language subsets, and improves code readability. Verification that these practices have been adhered to reduces risk of software malfunction for the project during its operations and maintenance phases.

3. Guidance

Coding standards are used to prevent or reduce unsafe coding practices. Planning for the adoption and use of coding standards at the beginning of a software development activity sets the right tone and approach for the development team.

Software coding standards are classified by language, usage, and severity levels. Language specific rules and best coding practices are usually determined by experts in the particular language [e.g., C++, ADA] and tailored as needed by the project. Usage types and severity levels are set by the user. 326

To assist you in fulfilling this requirement, interpret the text in section 1 as "software coding methods," "software coding standards," and "software coding criteria." Also, interpret the terms "methods" and "criteria" as being indictive of the style of the software developer.

Over time, correlations between bugs and coding practices resulted in a set of rules that helped to prevent coding errors from occurring. 326 These activities resulted in recommendations to develop and use coding standards.

"A comprehensive coding standard encompasses all aspects of code construction. ...Properly completed source code reflects a harmonized style, as if a single developer wrote the code in one session. At the inception of a software project, a coding standard is established to ensure that all developers on the project are working in concert. When the software project incorporates existing source code, or when performing maintenance on an existing software system, the coding standard states how to deal with the existing code base.

"The readability of source code has a direct impact on how well a developer comprehends a software system. Code maintainability refers to how easily that software system can be changed to add new features, modify existing features, fix bugs, or improve performance. Although readability and maintainability are the result of many factors, one particular facet of software development upon which all developers have an influence is coding technique. One of the easiest methods to ensure a team of developers will yield quality code is to establish a coding standard, which is then enforced at routine code reviews". 161

In a team environment or group collaboration, the use of coding standards ensures uniform coding practices, reduces oversight errors, and the time spent in code reviews. When NASA software development work is outsourced to a supplier (see Topic 7.3 - Acquisition Guidance), having a set of coding standards in place helps to ensure that the code produced by the contractor meets quality requirements mandated by NASA in the NASA Software Assurance Standard, NASA STD 8739.8. 278

A coding standard document may be written as a general document that is independent of any project.  Project-specific needs are then added as amendments to the document. Note there is an important difference between a coding style and a coding standard. A coding style specifies how you indent lines or employ tabs and spaces to make the code easier to read by the software development team. A coding standard, which often includes a coding style, goes beyond just how to name a variable. It tells you how that variable is to be treated and when it is to be used (and not used). 006 Use of these standards will help the developer avoid actions that are not a smart practice to get into. They may also restrict coding statements to language statements from national or international standards.

One way to tell the difference between a coding style element and a coding standard element is to compare the functionality of the resulting code if either element is removed or changed. For example, if the style element is not followed in the software work product, the code should still work exactly the same way, with exactly the same behavior and safety checks. However, if a coding standard element is removed or altered, it is likely that the the code's "safety" and/or functionality is changed. That is the difference between the two. A coding standard is obviously more important than a coding style. 326

How Coding Standards are Classified

Software coding standards are classified by language, usage, and severity levels. Language specific rules and best coding practices are determined by industry experts in that particular language. Usage types and severity levels are set by the user. 326

Coding standards should address (for all the languages used):

  • Code structure: Includes overall project layout (files, and so on), classes, resources, and other source file types.
  • Error handling: Describes how objects handle errors, reporting, and logging.
  • Limiting the size of modules.
  • Using library routines, especially the following:
    • Operating system routines.
    • Commercial library routines (e.g., numerical analysis).
    • Project-specific utility routines.
  • Defining constants and data types.
  • Using global data.
  • Using compiler-specific features not in the language standard." 077

The following items may be an integral part of the coding standard to the extent their implementation actually affects the outcome of the execution of the software. Otherwise they are part of the coding style.

  • Formatting: Includes the use of white space, indentation, and length of statement lines in code. Some standards might include, for example, common editor setup and handling for tabs versus spaces for indentation.
  • Naming conventions: Specifies how developers name their methods, classes, variables, events, and parameters.
  • Comments: An English description in the code that explains the logic of the code. (Quality code is usually self-documenting by default.) The use of quality commenting gives quality code better maintainability and easier understandability.

Adherence and Verification

Assuring the adherence of the developed software to the coding standards provides the greatest benefit when followed from software development inception to completion. Coding standards are selected at the start of the software development effort. Verification activities of the software work products (see SWE-028) include reviews, such as peer reviews and inspections (see SWE-087), and assessments of how the coding standards are used to develop the software work products. The use of automated tools for assessing adherence to standards at appropriate reviews, or even on a batch mode run overnight, will assist the project team in adherence and verification.

How to Interpret the "and/or" Phrase in the Requirements Statement

The "and/or" in the text of the requirement statement is meant for flexibility in tailoring the requirement to the needs of the project. In appropriate settings (e.g., less "critical") a subset of this list (the "or" in "and/or") would be sufficient and compliant. For human-rated applications, the project would want to cover each of the items (methods, standards, criteria) in the statement (the "and" in "and/or"; e.g., the use of Klockwork tool as part of the "method," MISRA-C (software development standard for the C programming language developed by MISRA (Motor Industry Software Reliability Association).) "standards," avoidance of the project's restricted language constructs "criteria," etc).

Additional guidance related to the planning and control of software coding standards, and where they may be used, may be found in the following related requirements in this Handbook:

SWE-025

Corrective Actions

SWE-058

Detailed Design

SWE-060

Coding Software

SWE-063

Release Version Description

SWE-135

Static Analysis

SWE-136

Validate Software Tools


4. Small Projects

Smaller projects may consider using previously developed/tailored coding methods, standards and guidelines, rather than developing their own. These standard applications may be available in the software Process Asset Libraries (PAL) of other Centers, if not available at the performing Center.

5. Resources

5.1 Tools

Tools relative to this SWE may be found in the table below. You may wish to reference the Tools Table in this handbook for an evolving list of these and other tools in use at NASA. Note that this table should not be considered all-inclusive, nor is it an endorsement of any particular tool. Check with your Center to see what tools are available to facilitate compliance with this requirement.

Tool nameTypeOwner/SourceLinkDescriptionUser

StyleCop

Open Source

Open Source

http://stylecop.codeplex.com/releases/view/48036 ...

StyleCop analyzes C+ source code to enforce a set of style and consistency rules. It can be run from inside of Visual Studio or integrated into an MSBuild project.

PurifyPlus

COTS

UNICOM Systems, Inc.

https://teamblue.unicomsi.com/products/purifyplus/?cmmcuid=17201434002914876099162cmmcsid50200000=14 ...

Run-Time Analysis Tools for Application Reliability and Performance

LaRC,JPL

KlocWork Insight

COTS

Rogue Wave Software

https://www.roguewave.com/products-services/klocwork ...

A proven and widely deployed development productivity solution, Klocwork Insight enables early detection of a wide range of critical coding issues. With Klocwork Insight, software developers can run powerful static analysis at their desktop, and team leads and architects can access architecture visualization as well as important build-level metrics and trending data.

KSC (Launch Control System), ARC, JPL, IV&V

JPL C Coding Standard

SPAN - Accessible to NASA users via SPAN tab in this Handbook. By Request - Non-NASA users, contact User for a copy of this tool.

JPL

...

An example of a coding standard for programming in c. Search in SPAN: JPL__ST_20090303_C_Coding_STD

JPL

FxCop

Open Source

MicroSoft

http://msdn.microsoft.com/en-us/library/bb429476%28v=vs.80%29.aspx ...

FxCop is an application that analyzes managed code assemblies (code that targets the .NET Framework common language runtime) and reports information about the assemblies, such as possible design, localization, performance, and security improvements.

FindBugs

Open Source

University of Maryland

http://findbugs.sourceforge.net ...

FindBugs, a program which uses static analysis to look for bugs in Java code. It is free software, distributed under the terms of the Lesser GNU Public License. The current version of FindBugs is 3.0.1, released on 13:05:33 EST, 06 March, 2015.

GRC (EVA Sim; EVA-Informatics), ARC, JPL, KSC

Eclipse IDE

Open Source

Eclipse Foundation

http://www.eclipse.org/downloads/ ...

An integrated design environment (IDE) tool for software development. Eclipse is an open source community, whose projects are focused on building an open development platform comprised of extensible frameworks, tools and runtimes for building, deploying and managing software across the lifecycle.

JPL

Coverity® Prevent and Extend™

COTS

Synopsys

https://www.synopsys.com/software-integrity/security-testing/static-analysis-sast.html ...

Static code analysis

JPL, IV&V

CodeHawk C Analyzer

COTS

Kestrel Technology

https://www.tekspedite.com/technologyprofile/30 ...

CodeHawk C analyzer is a software assurance tool capable of proving the absence of all memory access vulnerabilities in C source code by leveraging KT’s abstract interpretation engine, a static analysis technology able to mathematically model program behavior.

ARC

CheckStyle

Open Source

SourceForge

http://checkstyle.sourceforge.net/ ...

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. It automates the process of checking Java code to spare humans of this boring (but important) task. This makes it ideal for projects that want to enforce a coding standard.

KSC

6. Lessons Learned

The NASA Lessons Learned database contains the following lessons learned related to coding standards:

  • Software Design for Maintainability. Lesson Number 0838. NASA has long recognized that software maintenance is a large cost driver in its software systems. Early planning for maintenance, which includes the use of appropriate and consistent coding standards, coding styles, and software configuration management systems, helps hold down software maintenance costs over the software life cycle. The lessons learned citation given below provides additional information on this topic of coding standards. 526.
  • Mars Pathfinder Flight Software Development Process (1997). Lesson Number 0590. The software developer should also recognize that there is benefit to using coding standards dedicated to the project at hand. As this set of lessons learned derived from the Mars Pathfinder project shows, even though the coding standards and styles were tailored for the project, maintaining the set of derived coding standards for future upgrades and improvements will assure cost control 510

The reader of this lessons learned can also derive the warning that use of tailored coding standards for a new project raises the potential for error if extensive reuse of software work products is anticipated.