Code rule
Download as PPT, PDF1 like865 views
The document provides coding style guidelines for variables, functions, classes and other elements in C++ code. Some of the key points include: - Use meaningful prefixes and names for variables and functions - Initialize variables during declaration when possible - Functions should perform a single well-defined action - Class members should be private with public get/set accessors - Parameter types should be consistent and avoid default values - Loop variables should have meaningful names beyond simple indexes - Prefer clearer alternatives to switch statements in loops - Related functionality should be split across multiple focused functions
Code rule
- 1. Coding Rule
- 2. Name of Variable No prefix like “s” “w” “i” “l” Use “m_” for data member , use “p” for pointer m_pDataType (OK) m_pdata_type (No) m_pData_Type (No) Use acronym carefully. m_DT4O2T (m_DataTypeForO2T will be better, O2T is common usage acronym, it is OK)
- 3. Initialization int memberCount = -1; or int memberCount = 0; -1 could be the state means the member is not initialized or not used. Choose as you need. Definition with initializing. CParamClass* pParam = NULL; int memberCount = 0;
- 4. Name of function Use full word as possible. Initialize() (OK) Init() ( No ) GetCount() (OK) GetCnt ( No ) Exception: Min/Max IsXXX, DoesXXX, CheckXXX, should be “Verb + detailed action + (with/using/by) conditions (optional)” Don’t do 2 or more action in one function. GetAndSetXXX ( No! ) do assignment in GetXXX function ( No! ) Should look like normal English sentence.
- 5. Class Don’t need protected Data member should be private Set/Get Put/Get use as pair If possible, member function should be const Do Not need class name in member function or member m_pEDSDevice (NO!) m_pDevice (OK) in CAssemblyClass, m_AssemblyMemberCount (No) m_MemberCount (OK)
- 6. Use int as possible. Function name should be meaningful. AssembleEx (no) AssembleUsingIndirectParam (OK) GetParam3 (no) GetParamByKeyname (OK) Make name useful. CalcByteSize (OK) CalcBitSize (OK) CalcBitSizeEx (No) CalcSize (If size is only used bit or byte length, it is OK, otherwise, should be more detailed name)
- 7. Function parameter Value is changed in function, use pointer (int *pValue) Value will not change, use const reference for Class/Structure type. (const COneClass& oneObject) If different return states, use HRESULT.
- 8. Do not use default parameter in function Void SetParamValue (int index, int value, int bitOffset = 0, int startBitPosition = 0); ( No ) Change to 2 different functions. SetParamValue(int index, int value); SetParamWithBitPosition (int index, int value, int bitOffset, int startBitPosition); for (int i=0; i< xxx; i++) If for is not very simple (there are another for/while/switch/if in for-loop), the i should be another meaningful name, personIndex / bookIndex etc. Do not use overload if you don’t need it. Different name for similar functions.
- 9. NOT use “switch” with “for/while/dowhile” loop, because the “break” of switch will cause confusion. Change switch to “if-elseif-else”. (In seldom case you need it for performance, seldom!) UpdateData (bSave); // save or get in MFC Change to 2 pair functions SaveDataFromDialog() and SetDataToDialog()
- 10. Watch the variable in initialization / running