GithubHelp home page GithubHelp logo

Document the coding style about modmesh HOT 7 CLOSED

yungyuc avatar yungyuc commented on August 16, 2024
Document the coding style

from modmesh.

Comments (7)

tigercosmos avatar tigercosmos commented on August 16, 2024 1

Let me provide some points:

  • We are using snake case for functions and variables for non-QT-related code
  • need to have /* end of xxx */ where xxx is a namespace or class.
  • follow the rule of 5
  • follow doxygen comment style
  • comment for reference is highly recommend
  • class member start with m_.
  • macro start with DECL_MM_.

from modmesh.

ThreeMonth03 avatar ThreeMonth03 commented on August 16, 2024 1

@ThreeMonth03 I will try to put together a style guide by following your attempt in #362.

Thank you, I look forward to seeing the guideline.

from modmesh.

ThreeMonth03 avatar ThreeMonth03 commented on August 16, 2024

I think we could refer the Google C++ Style Guide,
and write the simpler guide for modmesh.

I will pull the draft by 6/10(Mon.).

In the draft, I expect it will list the guide about naming, comments and formatting.

from modmesh.

ThreeMonth03 avatar ThreeMonth03 commented on August 16, 2024

I think we could refer the Google C++ Style Guide, and write the simpler guide for modmesh.

I will pull the draft by 6/10(Mon.).

In the draft, I expect it will list the guide about naming, comments and formatting.

Here is a simple draft.
#362 (review)

from modmesh.

yungyuc avatar yungyuc commented on August 16, 2024

@ThreeMonth03 I will try to put together a style guide by following your attempt in #362.

from modmesh.

yungyuc avatar yungyuc commented on August 16, 2024

Fixed by #394

from modmesh.

yungyuc avatar yungyuc commented on August 16, 2024

I created #395 for further discussions on the coding style.

from modmesh.

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.