自用文件代码命名规范

自用文件代码命名规范

Written by PNJie
码字不易，转载请标注出处，谢谢~

文件命名

文件夹/文件总命名逻辑：

(前缀)_文件名_版本号_日期

文件名使用大驼峰命名法

例如：

LtspiceSimulation //Ltspice 仿真文件夹

遇到命名中有缩写用"_"将缩写隔开

例如：

DPT_TestResult //双脉冲仿真测试结果文件夹
AD_PCB_Design //PCB设计文件夹
  

一些前缀：

前缀	释义
Code	代码
Sim	仿真
Doc	各种文件
Misc	杂项

版本号与日期：

版本号采用V主版本号.子版本号.修正版本号

例：

V0.0.0

初期版本命名为：V0.0.0

• 修正版本号：需要保留前一版本，同时对前一版本进行小幅度修改时，修正版本号+1；
• 子版本号：需要保留前一版本，且前一版本已经生产，对前一版本进行较大修改或debug时，子版本号+1；
• 主版本号：对之前版本进行大幅度改动时，新增/变动功能时，主版本号+1；

版本号加在文件命名之后，通过下划线连接：

例：

LLC_TestBoard_V0.1.1 //LLC 测试板

一些特殊版本：

缩写	释义
DRAFT/TEMP/DEMO	随便写写画画的版本
ROOT/MOTHER/BASE	母版，复制粘贴进行修改，不在母版内进行改动
FINAL/FROZEN	不再进行改动的版本
ESSENTIAL	非常重要的版本，加粗划重点

例：

LLC_TestBoard_ROOT_241127 //LLC 测试母版

日期采用年月日命名法，且年只用后两位，月日为两位，缺0补0，例：

241205 //2024年12月05日

代码公式变量命名

学习：https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/naming.html#general-naming-rules

关于大小写：

• 变量/时变量全部小写
• 常量全部大写

例：
$$\begin{gathered} VDD=5//VDD是为5的常量 \\ {v}_{gs}(t)//vgs是随时间变化的变量 \end{gathered}$$

关于代码变量：

类class使用大驼峰命名法，遇到缩写则首字母大写：

例：

MyTestData //class数据，数据组
MyTestData.voltage
LlcTestData //遇到缩写则只有首字母大写

其余变量一律小写，常量全部大写，变量命名采用描述性短句，且用下划线连接

例：

voltage 		//电压变量
voltage_rising_time //电压上升时间
static VDD = 5V //VDD 常量

等于号前号后加一个空格。