Skip to content

Add a lint to enforce the naming convention in README #5

@chengcli

Description

@chengcli

Currently, this repo uses cpplint to enforce c++ style. But cpplint does not check naming conventions. Is it possible to find a lint library that check cpp naming convention? Basically, I would like to enforce:

Name your folders and files

  • use a singular simple noun for folder names
  • avoid compound nouns for folder names
  • you can use compound nouns or phrases for files names
  • individual words in a compound nouns for phrase should be concatenated by underscore

Name your variables and classes

  • use low case letters for variables
  • you can use compound nouns or phrases
  • compound nouns for phrase should be concatenated by underscore. This is called the snake case
  • if a compound noun is used for class name, capitalize each word in the compound noun.
    This is called the upper camel case
  • if a variable is a private member of a class, append the variable name with an
    underscore

Name your funcions

  • functions names are usualy verbal phrases
  • standalone functions should use snake case
  • public class member functions should use upper camel case
  • private class member functions should use lower camel case in which the first word
    in a phase is not capitalized and the rest words are capitalized

Metadata

Metadata

Assignees

Labels

help wantedExtra attention is needed

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions