[c][cpp]: c和cpp的命名规则（变量、函数、类、结构、枚举、共用）

[c][cpp]:  c和cpp的命名规则（变量、函数、类、结构、枚举、共用）

 

 

 

 

一、说明：为了更好识别变量、函数、类、结构体，因此制定命名规则

 

　　1、全局变量的命名规则：　　g_<变量名>

 

　　2、函数的命名规则：　　f_<函数名>

 

　　3、【class(类)】的命名规则：　　c_<类名>

　　　　4.1、类的成员变量的命名规则：　　mv_<变量名>

　　　　4.2、类的成员函数的命名规则：　　mf_<函数名>

　　　　4.3、类的静态变量的命名规则：　　sv_<变量名>

　　　　4.4、类的静态函数的命名规则：　　sf_<函数名>

 

　　4、【struct(结构)】的命名规则：　　s_<结构名>

　　　　4.1、结构的成员变量的命名规则：　　mv_<变量名>

　　　　4.2、结构的成员函数的命名规则：　　mf_<函数名>

　　　　4.3、结构的静态变量的命名规则：　　sv_<变量名>

　　　　4.4、结构的静态函数的命名规则：　　sf_<函数名>

 

　　5、【enum(枚举)】的命名规则：　　e_<枚举名>

 

　　6、【union(共用)】的命名规则：　　u_<结构名>

　　　　4.1、共用的成员变量的命名规则：　　mv_<变量名>

　　　　4.2、共用的成员函数的命名规则：　　mf_<函数名>

　　　　4.3、共用的静态变量的命名规则：　　sv_<变量名>

　　　　4.4、共用的静态函数的命名规则：　　sf_<函数名>

　　　　4.5、【共用】特别说明：　　在【共用】中，可以定义函数（cpp；std=c++23）。【参考文献： https://en.cppreference.com/w/cpp/language/union  】

//  c++
//  g++ -std=c++20 -O2 -Wall -pedantic -pthread main.cpp && ./a.out

#include <iostream>
#include <string>
 
union u_S
{
    u_S()
    { 
        std::cout << "\n[os]#\tunion::S()" << std::endl;
    }
    
    u_S(std::string s):mv_str(s){}
    
    ~u_S() 
    { 
        std::cout << "\n[os]#\tunion::~S()" << std::endl;
    }
    
    void mf_msg() 
    { 
        std::cout << "\n[os]#\tstr := " << mv_str << std::endl;
    }
    
    void mf_tell()
    { 
        std::cout << "\n[os]#\ts::tell()" << std::endl;
    }
    
    int mf_work()
    { 
        std::cout << "\n[os]#\twork:1" <<std::endl;
        return 1;
    }
    
    static void sf_big()
    {
        std::cout << "\n[os]#\ts::sf_big() := " << u_S::sv_big << std::endl;
    }
    
    std::string mv_str;
    
    static int sv_big;

};

int u_S::sv_big = 345;
 
int main()
{
    u_S s = {"Hello, world"};
    s.mf_msg();
    s.mf_tell();
    s.mf_work();
    u_S::sf_big();
    
    return 0;
}


/****  result  ****/

[os]#    str := Hello, world

[os]#    s::tell()

[os]#    work:1

[os]#    s::sf_big() := 345

[os]#    union::~S()

 

二、代码

/*
*    file_name  :=  ruler_of_name.cpp
*    date  :=  2024-01-24
*
*
*    the ruler of name:
*
*        1.  global name of variable  =  g_<variable_name>
*
*        2.  a name of general function  =  f_<function_name>
*
*        3.  class
*            3.1  a name of class type:    c_<class_name>
*            3.2  variable name of class members:    mv_<variable_name>
*            3.3  function name of class members:    mf_<function_name>
*            3.4  static variable name of class:    sv_<variable_name>
*            3.5  static function name of class:    sf_<function_name>
*
*        4.  struct
*            4.1  a name of struct type:    s_<struct_name>
*            4.2  variable name of struct members:    mv_<variable_name>
*            4.3  function name of struct members:    mf_<function_name>
*            4.4  static variable name of struct:    sv_<variable_name>
*            4.5  static function name of struct:    sf_<function_name>
*
*        5.  enum
*            5.1  a name of enum type:    e_<enum_name>
*
*        6.  union
*            6.1  a name of union type:    u_<union_name>
*            6.2  variable name of union members:    mv_<variable_name>
*            6.3  function name of union members:    mf_<function_name>
*            6.4  static variable name of union:    sv_<variable_name>
*            6.5  static function name of union:    sf_<function_name>
*
*/

#include <iostream>
#include <string>

using namespace std;

//  global variables name  =  g_<variable_name>
string g_os  =  "Linux Fedora" ;
string g_prompt  =  "[os]#\t" ;

//  a name of general function  =  f_<function_name>
void f_msg()
{
    cout << "[os]#\tHello, World!" << endl ;    
}

//  a name of class type  =  c_<class_name>
//  variable name of class members =  mv_<variable_name>
//  function name of class members =  mf_<function_name>
//  static variable name of class =  sv_<variable_name>
//  static function name of class =  sf_<function_name>
class c_object      //  class name  =  c_<class_name>
{
private:
    //  variable name of class members =  mv_<variable_name>
    string mv_name = "" ;
    
public:
    c_object(){}
    
    //  function name of class members =  mf_<function_name>
    void mf_msg() {}
    
    //  static variable name of class =  sv_<variable_name>
    static int sv_count ;
    
    //  static function name of class =  sf_<function_name>
    static void sf_tell() 
    {
        cout << "[os]#\tsf_tell()" << endl;    
    } 
};
int c_object::sv_count  =  0 ;

//  a name of struct type  =  s_<struct_name>
struct s_msg
{
    //  variable name of struct type  =  mv_<variable_name>
    string   mv_name  =  "" ;

    //  function name of struct type  =  mf_<function_name>
    void mf_msg()
    {
        cout << "[os]#\ts_msg::mf_msg()" << endl ;
    }

    //  static variable name of struct  =  sv_<variable_name>
    static string sv_name ;
    //  static function name of struct  =  sf_<function_name>
    static void sf_work()
    {
        cout << "[os]#\ts_msg::sf_work("<< s_msg::sv_name <<")" << endl ;
    }
};
string s_msg::sv_name = "s_msg::sf_name" ;

// enum name  =  e_<enum_name>
enum e_color
{
    RED ,
    YELLOW ,
    BLUE
};

// print e_color object
void f_print_msg_ecolor(e_color clr)
{
    //e_color clr = RED ;
    cout << "[os]#\t" << "f_print_msg_ecolor(" << clr << ")" << endl ;
}

//  union name  =  u_<union_name>
union u_persion
{
    // constructer of union
    u_persion()
    {
        string msg  =  "u_persion()" ;
        cout << "[os]#\t" << msg << endl ;
    }
    u_persion(string name):mv_name(name)
    {
        string msg  =  "u_persion(string name)" ;
        cout << "[os]#\t" << msg << endl ;
    }

    // destructer of union
    ~u_persion()
    {
        string msg  =  "~u_persion()" ;
        cout << "[os]#\t" << msg << endl ;
    }

    // a function name of union  =  mf_<function_name>
    void  mf_speak()
    {
        string msg  =  "mf_speak(), " ;
        cout << "[os]#\t" << msg << mv_name << endl ;
    }

    // a static function name of union  =  sf_<function_name>
    static void sf_work()
    {
        string msg  =  "sf_work(),  " ;
        cout << "[os]#\t" << msg << u_persion::sv_count << endl ;
    }

    // a variable name of union  =  mv_<variable_name>
    string mv_name ;

    // a static variable name of union  =  sv_<variable_name>
    static int sv_count ;
};
int u_persion::sv_count = 360 ;

//  a name of a function  =  f_<function_name>
void f_run()
{
    cout << g_prompt << g_os << endl ;

    //  class
    c_object::sf_tell() ;
    c_object co ;
    co.mf_msg() ;

    // struct
    s_msg sm ;
    sm.mf_msg() ;

    //  enum
    e_color clr = RED ;
    f_print_msg_ecolor(clr) ;

    //  union
    u_persion::sf_work();
    u_persion up{"sun-wukong"};
    up.mf_speak();
   
}

//  the entrance of this procedure
int main()
{
    f_run();
    return 0;    
}

 

三、运行结果

g++ -std=c++20 -O2 -Wall -pedantic -pthread main.cpp && ./a.out


[os]#    Linux Fedora
[os]#    sf_tell()
[os]#    s_msg::mf_msg()
[os]#    f_print_msg_ecolor(0)
[os]#    sf_work(),  360
[os]#    u_persion(string name)
[os]#    mf_speak(), sun-wukong
[os]#    ~u_persion()

 

四、参考文档

 

　　1、　　union declaration　　--　　https://en.cppreference.com/w/cpp/language/union