GithubHelp home page GithubHelp logo

Naming style about inline-engine HOT 2 CLOSED

petiaccja avatar petiaccja commented on June 16, 2024
Naming style

from inline-engine.

Comments (2)

petiaccja avatar petiaccja commented on June 16, 2024 1

Naming
Variables: camelCase
Functions: PascalCase
Class Members: m_camelCase
POD Struct Members: camelCase
Member Funcions: PascalCase
Enums: ePascalCase
Enum Constants: ALL_CAPS

File Names: CamelCase

Indentation
1 tab
Opening braces same line
Don't be retard

Member ordering
class C {
// private typedefs, classes, constexprs, friends, etc.
public:
// constructor -> operator= -> indexers -> public interface
protected:
// protected member functions
protected:
// protected member variables
private:
// funtcions
private:
// variables
};

Namespaces
Whole project in "inl"
Namespace for each module: e.g. inl::gxeng, inl::gxapi

Documentation
XML Doc comments: ///

Description.

from inline-engine.

petiaccja avatar petiaccja commented on June 16, 2024

See Wiki here on github

from inline-engine.

Related Issues (20)

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.