Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.61 KB

XDN02 - Engineering Guidelines.md

File metadata and controls

33 lines (20 loc) · 1.61 KB
id title author status
XDN02
Engineering Guidelines
draft

Title: XLDN02 - Engineering Guidelines

Abstract

The xlang Project involves many components written in a variety of programming languages. This document describes coding guidelines for each language.

Coding Guidelines

This project adopts industry standard guidelines where one exists. As new language support is added to the project, this list will be expanded to include applicable standards.

The project references these as guidelines, not laws. Thoughtful deviation is allowed if it aids readability of the specific code in question or is necessary for a technical reason. However, guidelines should not be ignored because of a disagreement with the guideline itself.

Due to the nature of language interoperability, types expressed using the xlang type system will adhere to naming guidelines in some languages and deviate from others. Naming conventions of the xlang type system take precedence over language-specific guidelines where applicable.

References by language