首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Python代码规范命名规范

前言 Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯 目录 一、简明概述 1、编码 如无特殊情况, 文件一律使用 UTF...-8 编码 如无特殊情况, 文件头部必须加入#-*-coding:utf-8-*-标识 2、代码格式 2.1、缩进 统一使用 4 个空格进行缩进 2.2、行宽 每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过...,因此 代码里 多数应该使用 单引号 自然语言 使用双引号 "..."...'blah': do_blah_thing() # 不推荐的写法 if foo == 'blah': do_blash_thing() 6、docstring docstring 的规范中最其本的两点...""" 文档注释不限于中英文, 但不要中英文混用 文档注释不是越长越好, 通常一两句话能把情况说清楚即可 模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释 三、命名规范

1.9K20
您找到你想要的搜索结果了吗?
是的
没有找到

我的php命名规范

1.变量 所有字母都使用小写,使用'_'作为每个词的分界,如$user_name 2.函数 函数的命名使用小写字母和下划线的方式,如get_client_ip 3.方法 方法的命名使用驼峰法,并且首字母小写或者使用下划线...getUserInfo,_formatAge,通常下划线开头的方法属于私有方法; 以双下划线“__”打头的函数或方法作为魔法方法,例如 __call 和 __autoload; 4.类名 类名使用驼峰法命名...,并且首字母大写,另外类名和文件名保持一致 5.常量 常量以大写字母和下划线命名,例如 HAS_ONE和 MANY_TO_MANY; 配置参数以大写字母和下划线命名,例如HTML_CACHE_ON 6....属性名 属性的命名使用驼峰法,并且首字母小写或者使用下划线“_”,例如 tableUser、_instance,通常下划线开头的属性属于私有属性;

81780

PHP系列 | PHP Document 注释标记及规范 && PHP命名规范

普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种: {@link} 用法同@link {@source} 显示一段函数或方法的内容 注释规范...g.必要的地方使用非文档性注释,提高代码易读性。 h.描述性内容尽量简明扼要,尽可能使用短语而非句子。 i.全局变量,静态变量和常量必须用相应标记说明 示例 <?...命名规范 先了解下 1、什么是 驼峰命名法?...百度百科 1.类名:大驼峰命名法 2.类属性: public、protected类型的,小驼峰命名法; private类型的,下划线(_)开头,小驼峰命名法; 3.类方法: public、protected...类型的,小驼峰命名法; private类型的,下划线(_)开头,小驼峰命名法; 4.类方法参数:小驼峰命名法; 5.函数:采用C GNU的惯例,所有的字母使用小写字母,使用下划线(_)分割单词; 6.函数参数

1.2K21

PHP代码规范

PHP编码规范 1. 标识符命名规范 标识符的命名力求做到统一、达意和简洁。...2基本代码规范 2.1概览 l  PHP代码文件必须以 <?php 或 <?...),二者只能选其一; l  命名空间以及类必须符合 PSR 的自动加载规范PSR-4; l  类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范; l  类中的常量所有字母都必须大写,单词间用下划线分隔...PHP标签 PHP代码必须使用  长标签 或  短输出标签; 一定不可使用其它自定义标签。 2.2.2. 字符编码 PHP代码必须且只可使用不带BOM的UTF-8编码。...类的命名必须 遵循 StudlyCaps 大写开头的驼峰命名规范PHP 5.3及以后版本的代码必须使用正式的命名空间。

2K30

PHP - 代码规范PSR

概述仔细的缕了一下关于PHP代码的书写规范,我发现我确实有很多不足的地方,需要改进,PHP代码遵循PSR(PHP Standard Recommendation)规范,之前忘了看那本书到psr4,psr4...代码写的很随意,显得自己不专业,也给别人的阅读带来不便。...,方便调用,而且在性能上也更优,PHP的底层调用函数结束后,释放资源,如果不分离代码,需等待全部程序执行完毕在统一释放。...0;}6.PHP5到PHP7的变化PHP5最重要的特性就是丰富了面向对象的设计和语法,PHP7最大的特性就是提升了性能,PHP7还有个小细节是弱类型语法像强类型语法转变的风格,参数做了很大的限制。...10.PHPstrom的设置,命名规范还有个小窍门,如果是命名规范,PHPstrom会提示绿色波浪线,注释不规范就会提示黄色波浪线,下面是不规则的Demo。

62810

令人头疼的代码命名规范……

前言 关于代码命名,我相信是经常困扰很多小伙伴的一个问题,尤其是对于强迫症晚期患者。怎么说呢,每次小编在写代码之前,总会在想啊想啊,用什么命名法好呢?...对于经常在C++、Java、Python等主流语言上切换的强迫症来说,换个语言换种命名风格简直不要太混乱。 今天就来梳理一下常见的代码命名规范以及适用范围吧。 常见命名规范 为什么需要命名规范呢?...实际上好的代码本身就是注释,我们要尽量规范和美化自己的代码来减少不必要的注释。若编程语言足够有表达力,就不需要注释,尽量通过代码来阐述。 要想让你的编程语言足够有表达力,良好的命名规范是必不可少的。...同时,花几分钟学学规范命名,也能让你的代码看起来赏心悦目,何乐而不为呢。 1....Java命名规范 总体命名规范 类名需要使用大驼峰命名法(UpperCamelCase)风格。 方法名、参数名、成员变量、局部变量需要使用小驼峰命名法(lowerCamelCase)。

5.1K31

命名规范

---- 1. java 由字母、数字、下划线、$符号组成 不能以数字开头 名称不能使用JAVA中的关键字 坚决不允许出现中文及拼音命名 类名,接口名--大写驼峰 变量名,方法名--小写驼峰 项目名,包名...数据库 由英文、数字、下划线组成 多个单词用下划线分割 不能出现关键字 全部小写命名 表名--要有库名前缀,并且单数 字段名--不能重复表的名称 3....URL设计 小写字母和连字符 4. git提交规范 feat: 表达你完成了一个功能 fix: 表达你修复了一个bug docs: 书写一些文档 style: 修改了一些代码风格的东西,这些修改并不影响真正的代码运行...例如说删掉一个空格啦、用空格代替tab啦、忘记了写某个分号啊...等等 refactor: 重构代码 chore: 完成其他的修改,既不是新功能,也不是重构,也不是修复bug的其他修改 perf: 表达你对当前的代码做了一些优化

1.6K10

PHPPHP代码编写规范

PHP代码编写规范 一、编辑器设置 1、使用Tab缩进(四个空格),不要直接使用空格 2、文件编码格式 二、命名设置 1、公共库名称空间 2、变量命名 2.1、所有字母都使用小写 2.2、首字母根据变量值类型指定...整数I、浮点数f、字符串s、布尔值b、数组a、对象o、资源r、混合类型m 2.3、使用’_’作为每一个词的分界 3、类命名 3.1、使用大写字母作为词的分隔,其他的字母均使用小写,即驼峰格式。...” 或“set” 为前缀,当使用设计模式 5、类属性命名 5.1、属性名前缀应以属性值类型指定(具体参照变量命名规则) 5.2、前缀后采用与类命名一致的规则 5.3、私有属性采用’_’为前缀 6、方法中参数命名...6.1、参照类属性命名 7、全局变量 7.1、全局变量应该带前缀‘g’ 7.2、其余参照变量命名规则 8、定义命名/全局常量 8.1、全局常量使用’_’分割每个单词 8.2、所有字母使用大写 9、函数...9.1、所有的字母采用小写,使用’_’分割每个单词 10、文件命名 11、运算符优先级 声明 本文仅代表个人观点,仅供参考!

2.3K11

Android开发架构规范前言命名规范编程规范代码提交规范架构规范参考文章

当随着项目的代码量的提升,需要重构的时候。你会明白一个好的开发规范多么多么的重要。 这里整理一下自己android开发中的一些规范。希望对各位有帮助。...---- 命名规范命名规范 包名全部采用小写 主包名采用[公司性质].[公司名称]....代码命名规范 命名规则有很多高大上的名词,比如大驼峰,小驼峰,匈牙利命名法。其实最简单的就是按照谷歌命名学习。 常量、枚举等均采用大写形式,用下划线区分各单词。...这样也减少初始化代码。比如开源库PagerSlidingTabStrip ? 更多命名规范 之前收藏的这篇文章比较全。...Android 命名规范 (提高代码可以读性) ---- 编程规范 源文件编码格式为 UTF-8。

1.3K80

使用BEM命名规范来组织CSS代码

BEM 是 Block(块) Element(元素) Modifier(修饰器)的简称 使用BEM规范命名CSS,组织HTML中选择器的结构,利于CSS代码的维护,使得代码结构更清晰(弊端主要是名字会稍长...,可以复用而不依赖其它组件的部分,可作为一个块(Block) 属于块的某部分,可作为一个元素(Element) 用于修饰块或元素,体现出外形行为状态等特征的,可作为一个修饰器(Modifier) 在本规范中...可转换成设置对应的 元素来表现,如 */ .search-form {} .my-img { &__search-form-logo {} } BEM 规范虽然结构比较清晰,但有时候会产生代码冗余...为避免写太多重复性的代码,我们要学会善于利用预编译语言的(适当地使用 @include @extend 等)

95361

PHP 代码规范简洁之道

统一的编码规范 编码规范往简单说其实就是三个方面: 换行 空格 变量命名 放在 PHP 里面,还有一些附加的地方,比如关键字大小写,语法糖的使用(array() 与 [] 等)的问题。...之前整理过 PSR 的标准,也找过 php-cs-fixer 这样的工具。这些都是规范代码的重要手段。有统一的标准,配合上工具的检查,形成统一的编码约束不是什么难题。...没有规范,不同的人甚至同一个人在空格、换行和命名上都有可能是十分随意的。代码一长,回使整个文件看起来无比杂乱。 典型的例子比如:if 和 else 的组合,可以写出无数种风格,比如: ?...寻找最优的写法 写代码的过程中,最优的写法和编码习惯又不是同一件事情。这里要说的指的是如何遵循 PHP 的语言特性或者框架的特征,充分发挥语言和框架的能力来减少冗余。...偶尔 review 自己的代码也是对过去的总结,也许会有新的感知。 5. 推广给你的队友 团队项目中,队友的配合对整个代码规范起着决定性的作用。

1.1K60

CSS命名规范

(一)常用的CSS命名规则   头:header   内容:content/container   尾:footer   导航:nav   侧栏:sidebar   栏目:column   页面外围控制整体布局宽度...regsiter   状态:status   投票:vote   合作伙伴:partner (二)注释的写法:   /* Footer */   内容区   /* End Footer */ (三)id的命名...service   热点:hot   新闻:news   下载:download   投票:vote   合作伙伴:partner   友情链接:link   版权:copyright   (四)class的命名...:   (1)颜色:使用颜色的名称或者16进制代码,如   .red { color: red; }   .f60 { color: #f60; }   .ff8600 { color: #ff8600...  (3)对齐样式,使用对齐目标的英文名称,如   .left { float:left; }   .bottom { float:bottom; }   (4)标题栏样式,使用”类别+功能”的方式命名

1.5K20

Java命名规范

Java命名规范 定义规范的目的是为了使项目的代码样式统一,使程序有良好的可读性。 包的命名  (全部小写,由域名定义) Java包的名字都是由小写单词组成。...例如:MAX_VALUE 参数的命名 参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。...Javadoc注释 Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是我们 所说的Javadoc注释,它是用来记录我们代码中的API的。...变量和常量命名 变量的命名 主要的的命名规范有以下三种: Camel 标记法:首字母是小写的,接下来的单词都以大写字母开头 Pascal 标记法:首字母是大写的,接下来的单词都以大写字母开头...关于常量的命名方法,在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是 说,程序中除0,1以外,尽量不应该出现其他数字。

3.5K110
领券