id | title | author | status |
---|---|---|---|
XDN02 |
Engineering Guidelines |
draft |
- Ben Kuhn ([email protected])
- Status: Draft
The xlang Project involves many components written in a variety of programming languages. This document describes coding guidelines for each language.
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.
-
C++ code follows the C++ core guidelines
-
C# code follows the C# coding conventions
-
.NET types adhere to the .NET Framework Design Guidelines.
-
Python code is pythonic.