前言

命名规范的重要性:命名规范的重要性不下于代码说明的重要性
很多可以通过命名的类或者函数,明确使用的,避免重复开发,而在日常开发中沟通,有时候是面对面的、有时候是邮件、有时候是共同遵守的规则或者习惯。
一定要强调习惯,习惯可以是一个人成为优秀的人,习惯也可以使一个团队成为一个相对高效的团队,沟通无障碍的团队,需要有统一的命名规范
需要对各种域(范围或者维度的)命名要有一定的规范,由于程序员的英文水平不同意,建议可以使用汉语拼音来作为命名的基础
每次新增的概念或者名称都要录入命名库,从库中可以看到每个命名的含义。


文章目录

  • 前言
  • 一、文件的命名规则
  • 二、文件命名规范
  • 二、名称命名规范
  • 三、代码命名规范
    • 2、属性代码目录
    • 1、标题驼峰命名法
    • 1、函数的命名

一、文件的命名规则

网站中的所有文件命名全部用英文字母、数字、下划线、连字符的组合,其中不得包含汉字、空格和特殊字符。
尽量采用语义明确简单地英文单词命名。

常见命名 常见命名
静态首页文件 index/default
图片文件夹 img/images
样式表文件夹 css/styles
脚本文件夹 js/scripts
字体文件夹 fonts
板文件夹 templets
媒体文件夹 medias

二、文件命名规范

框架布局/布局,版面 layout.css
字体样式 font.css
链接样式 link.css
打印样式 print.css
主要的 master.css
专栏 columns.css
主题 themes.css

二、名称命名规范

页 眉 header 页 脚 footer
导 航 menu 版 权 copyright
主导航 mainMenu / mainnav 子导航 subMenu / subnav
顶导航 topnav 边导航 sidebar
左导航 leftsidebar 右导航 rightsidebar
边导航图标 sidebarIcon 面包屑 breadcrumb
内 容 content 容 器 container
登 录 login 标 志 logo
标 题 title 商 标 label
侧边栏 sidebar 外 套 wrap
图 标 Icon 标 语 banner
注 释 note 信息框 manage
搜 索 search 按 钮 btn
链 接 link 当前的 current
菜单内容1 menu1 content 菜单容量 menu container
子菜单 submenu 标 语\广告 banner
搜索 search 功能区 shop

三、代码命名规范

2、属性代码目录

g_ 全局变量 s_ 静态变量 m_ c++类成员变量
c_ 常量 a_ 数组 p_ 指针
fn_ 函数 v_ 无效 h_ 句柄
l_ 长整型 b_ 布尔 f_ 浮点型
dw_ 双字 sz_ 字符串 n_ 短整型
c_ 计数 d_ 双精度浮点 ch_ 字符
i_ 整型 by_ 字节 w_
r_ 实型 u_ 无符号
Max_ 最大 Min_ 最小 Init_ 初始化
T_ 临时变量(或Temp) Src_ 源对象 Dest_ 目的对象

1、标题驼峰命名法

驼峰命名法,就像名称所表示的一样,指的是多种混合使用大小写字母来构成标识符的名称,其中第一个单词首字母小写,余下的单词首字母大写,组成的一个完整的名称。

 this.humpName()//函数名中每一个逻辑断点都有一个大写字母来标记

1、函数的命名

函数名使用下划线分割小写字母的方式命名:
设备名_操作名();
操作名一般采用:谓语(此时设备名作为宾语或者标明操作所属的模块)或者谓语 宾语/表语(此时设备名作为主语或者标明操作所属的

tic_init();
adc_is_busy(){};
this.uart_tx_char();

事实上没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般都不指定命名规则。 只要简单明了,能明白其意就行。 命名规则对软件产品而言并不是“成败悠关”的事,我们不要化太多精力试图发明世界上最好的命名规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施。

文件及代码代码命名规则相关推荐

  1. Linux文件(目录)命名规则

    ♥️♥️♥️♥️♥️♥️介绍完 Linux 系统中目录结构之后,读者一定想知道如何为文件或目录命名. 我们知道,在 Linux 系统中,一切都是文件,既然是文件,就必须要有文件名.同其他系统相比,Li ...

  2. R语言入门教程知识 第二章 赋值代码与命名规则

    快捷键 新建脚本:  Ctrl + shift + N 清理控制台快捷键: Ctrl + L 赋值快捷键ALT + -  赋值法 1.符号方式赋值: 对象名 <- 对象值 2.函数方式赋值:as ...

  3. Android下载文件,如果文件夹下有同名文件,则重命名规则为a(2)、a(3)的实现

    具体实现如下: private String fileReleaseName;//文件最终名字 private String SD_FOLDER;//文件夹路径/** *传入文件默认名 **/ pri ...

  4. Web前端开发规范 : 文件命名规则

    转自 : https://blog.csdn.net/qq_26129689/article/details/52652000?ref=myread 1.文件命名规则 1.1文件名称的命名规则 统一用 ...

  5. C# 中委托实例的命名规则

    我们知道一个类中的属性应该用名词或名词性短语,方法用动词或动宾短语:但是委托的实例却似乎有一些游离.因为在 .NET 中委托代表的是一个动作,既可以把它看作是名词,也可以看作是动词.在用法上,既可以像 ...

  6. 【MATLAB】界面介绍 ( 标题栏 | 选项卡 | 命令窗口 | 编辑器 | 变量命名规则 )

    文章目录 一.MATLAB 界面介绍 二.MATLAB 变量名称规则 一.MATLAB 界面介绍 标题栏 : 标题栏 " MATLAB R2017a " 是 MATLAB 软件的版 ...

  7. Linux文件目录命名规则

    介绍完 Linux 系统中目录结构之后,读者一定想知道如何为文件或目录命名. 我们知道,在 Linux 系统中,一切都是文件,既然是文件,就必须要有文件名.同其他系统相比,Linux 操作系统对文件或 ...

  8. pythontdd测试命名_荐Pytest之测试命名规则

    背景: pytest以特定规则搜索测试用例,所以测试用例文件.测试类以及类中的方法.测试函数这些命名都必须符合规则,才能被pytest搜索到并加入测试运行队列中. 默认搜索规则: 如果pytest命令 ...

  9. C/C++代码规范(一)——文件结构、排版、命名规则

    代码规范是每个程序员倍加关注的问题.C语言编码与注释规范,懂不懂编码规范笔试时能一眼被看出来,有良好的编码习惯笔试时也会增色不少,知道你有过工作经验或者参与过大型项目.本文是在学习林锐博士的<高 ...

  10. python命名规则,代码规范

    python命名规则,代码规范 1.模块命名 2. 类命名 3.函数命名 4.变量命名 5.空行 1.模块命名 模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况) ...

最新文章

  1. 二维码检测哪家强?五大开源库测评比较
  2. 真假应用傻傻分不清,HideIcon病毒玩起“隐身计”
  3. Windows 10下安装Docker Desktop
  4. linux 权限 mask,【自学Linux】Linux用户、组、权限(一)
  5. 图例 | Java混合模式分析之火焰图实例
  6. 2019CCPC江西省赛
  7. html5+php调用android手机图片,HTML5拍照上传图片Phonegap封装HTML5调用Android相机拍照上传到PHP端...
  8. linux sql命令行查询语句不要换行_面试刷题mysql1:一条sql语句是如何经过mysql的体系结构的?...
  9. 深度强化学习之稀疏奖励(Sparse Reward)
  10. java服务器必读_Java服务器端编程安全必读
  11. 【Redis总结-基础入门】
  12. python 相似形态 股票_比对相似k线软件 python比对股市k线相似性
  13. 小程序源码:拼图工具箱支持多种拼图模式制作-多玩法安装简单
  14. flash火焰燃烧的文字效果
  15. Qt次线程向主程序发送信号收不到的问题
  16. Pandas数据探索
  17. 【Go学习笔记】数据类型之切片(slice)
  18. Caesers Cipher (凯撒密码)
  19. SAP EPIC 银企直连 付款接口(建设银行)
  20. micropython复现经典单片机项目(二)可视化音频 频谱解析(基本搞定)

热门文章

  1. Struts1.x ActionForm
  2. PC端QQ协议解析之0825
  3. Java开源CMS系统
  4. 劲爆周鸿祎网络炒作黑幕
  5. 瑞雪时晴,不亦快哉   ——图灵十一月月刊
  6. 在mac homebrew_您可以通过Homebrew在Mac上获得的最佳命令行工具
  7. 【✈躺平了,三分钟学bat脚本✈】adb shell 执行命令 + bat脚本延时操作
  8. CSDN x BSV|区块链工程师能力初级认证正式启动
  9. 计算机物理仿真,仿真物理实验室初中完整版
  10. java同步器有哪些_java 同步器 Semaphore、