Giter Site home page Giter Site logo

coding_guidelines's Introduction

Coding Guidelines

Table of Contents

This repository holds guidelines for a range of different programming languages. These guidelines consist of a style guide which defines the general source code format and naming of e.g. variables. Furthermore there is a programming guide which defines general rules, do's and don'ts to follow when writing source code.

The purpose of this repository is to help developers to achieve a more uniform style across code bases.

Golden Rule

Use common sense and be consistent. If your are extending, enhancing, or bug fixing existing source code, use the style that is already being used. This allows the source code to stay uniform and easy to follow. The point of having coding guidelines is to have a common base for writing code. It should help to provide a uniform code base across a project or organization/company and help other developers to understand the code base more efficiently.

Guides

For C++:

For CMake:

Inspiration

These coding guidelines were inspired by other already available guidelines namely:

For C++:

For CMake:

License

The project is licensed under the MIT license. See LICENSE for more information.

coding_guidelines's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.