1.变量.类名.函数名 使用驼峰命名法 2.尽量使用完整的单词命名,尽量不采用 缩写单词 3.类名使用大写字母打头,前缀统一加上HH 例如:HHHomePageController 4.类的成员变量使用 下划线打头, 例如_age 5.禁止在项目中的任何地方,包括文件名.目录名.逻辑目录名.项目名等地方使用空格或中文字符 6.为了不影响阅读,一个方法中代码不要超过100行.一个类中代码不要超过600行, 有超过的再回头重构的时候想办法分解 7.每个.h文件最开始处用简短文字说明一下该类的功能 8

程序目录规范:bin # 存放可执行程序 xxxx.py # 程序主程序(入口文件)config # 存放配置信息 settings.py # 全局配置文件(可能暂时未应用)db # 存放数据文件 course_info.pickel # 课程信息 student_info.pickel # 学生信息 teacher_info.pickel # 教师信息docs # 相关文档说明examples # 案例或者临时文件存放目录lib # 存放通用的库(例如:md5加密.文件是否存在检查) comm

第十八单元(redux中间件redux-thunk,redux工程目录的样板代码,规范目录结构) #课程目标 中间件:中间件增强redux的可扩展性,实现功能复用的目的. redux-thunk异步逻辑处理 redux-thunk的使用规范 #知识点 applyMiddleware 控制反转,action从对象到函数 redux-thunk原理 #授课思路 #案例和作业 完成异步请求,并渲染页面 api: http://apiv2.pinduoduo.com/api/fiora/subject/

php与数据库代码开发规范 1/25/2016 6:00:31 PM php对各类变量命名规范 目录名 文件命名 局部变量命名 使用英文动词名词,用下划线作为单词的分割,所有字母均使用小写 目录 upload templates install manage 文件 index.php register.php config.php $user $pay_time 全局变量使用英文名词动词 全部大写 用下划线分割 php中函数 符号 运算 写作规范化 数组变量命名 英文名词动词 下划线分割 所有字

PHPDocument 代码注释规范 1. 安装phpDocumentor(不推荐命令行安装)在http://manual.phpdoc.org/下载最新版本的PhpDoc放在web服务器目录下使得通过浏览器可以访问到点击files按钮,选择要处理的php文件或文件夹还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理.然后点击output按钮来选择生成文档的存放路径和格式.最后点击create,phpdocumentor就会自动开始生成文档了. 2．如何写PHP规范注

---恢复内容开始--- 1.json & pickle 磁盘上只能存储字符串或二进制数据,直接存字典.列表.元组等是存不了的,所以需要把各种数据转换成字符串格式,然后再存到硬盘. 直接将一个字典类型的数据写入硬盘,提示错误:TypeError: write() argument must be str, not dict. 将内存里的数据类型(字典.列表.元组.集合.字符串等)转换为字符串格式存入硬盘,这个过程叫序列化.反序列化就是再把硬盘里的数据加载回内存. 可以通过str()方法把一个字典

代码编写规范说明书(c#.net与asp.net) 目 录1 目的2 范围3 注释规范3.1 概述3.2 自建代码文件注释3.3 模块(类)注释3.4 类属性注释3.5 方法注释3.6 代码间注释4 命名总体规则5 命名规范5.1 变量(Variable)命名5.2 常量命名5.3 类(Class)命名5.4 接口(Interface)命名5.5 方法(Method)命名5.6 名称空间Namespace)命名6 编码规则6.1 错误检查规则6.2 大括号规则6.3 缩进规则6.4 小括号规则6

最近公司因为业务增多,又招了一个iOS小伙伴,内心无比开心呀.但是多了一个人,日常代码开发就要统一规范起来,方便日后维护和查找.下边列一下我日常用到一些代码规范. (一).SVN规范 1.代码一定要先update,(解决冲突),然后在commit. 2.代码提交. [人员][动作][动作内容] 如果代码中增加.修改文件,要写清楚增加了那个模块,那个文件夹,做什么功能的. 如果对代码进行删除,一定要和PM确定这个文件无用了,然后再删除文件,同时记得删除服务器上的文件. 如果对文件进行移动,要写清楚

软件开发目录规范 bin--启动文件 conf--配置文件 core--核心代码 db--数据文件 lib--常用功能代码 log--日志文件 readme--软件介绍

# 项目开发流程 1.调研 2.需求分析   ---产品经理 3.任务分配   ---项目经理 4.写项目demo   ---项目经理.架构师.程序猿 5.架构分析   ---项目经理.架构师 6.编写代码   ---程序猿 7.测试  ---黑盒测试.白盒测试 8.上线 项目开发目录规范 construc --bin:可执行文件,一般为项目入口,run.py ,main.py ,start.py 等 --conf:配置文件 --core:核心代码 --db:数据库操作 --interface:

最近参加了一个比赛,然后看到队友编程的代码,我觉得真的是觉得注释和命名规范的重要性了,因为几乎每个字符都要咨询他,用老师的话来说,这就是命名不规范的后续反应.所以此时的我意识到写一篇关于注释程序的重要性了,因此特地的写一篇文章规范自己,也帮助新手入门. (这篇文章已经是我自己更新的第三遍了,第一次叫浅谈注释的重要性,那时候我刚入门不久:学着学着我会发现变量名也很重要,第二次是规范变量名:这次我又改了,我觉得不止是这些东西,从长远的来说,编程以后就是自己的工作,或者说工具,所以遵循一套编码规则很重

1.目录规范 ***** (1)文件夹的规范写法 bin 可执行文件 conf 配置文件 core 主要业务逻辑 db 数据文件 lib 库 (公共代码 第三方模块) log 日志文件 readme 说明文档(是一个文件) 再以上文件夹中 没有需要作为包的 你的包通常放到lib中 但是注意lib不应该作为包 疑惑? # 这个文件夹到底应该是包还是文件夹 其实问题就是需不需要用到init # init的作用就是导入包内模块中的全部功能 # 通过判断是不是需要这个功能来判断是包还是文件夹 (2)定制

GIT库代码管理规范 一. 规范要求 1. 每个项目建立单独的GIT库.每个GIT库包括两条线,命名规则如下: 开发线(测试):项目名称_DEV 生产线(正式):项目名称 2. 每条线只允许增量不允许回滚: 3. 每个开发人员拉各自的分支开发,合并前先获取DEV代码,再提交合并: 4. 提交分支时注明:动作类型(新增.修改.删除)+改动明细: 5. 从开发线合并到生产线,由测试工程师负责拉代码/标注更新内容: 6. 由发布工程师将代码部署到服务器: 7. 禁止开发人员访问生产线,生产线不对开发人

import   sys print(sys.modules) 程序一运行,解释器将里面的所有内容全部加载到内存 项目目录规范: 代码不可能全部只写在一个文件,十几万行代码,调整,修改都很不方便. 所以要将代码规范化: 目录规范化, 具体代码规范,PEP8规范等等 目录规范化好处? 1.项目结构清晰,便于查找 2.对项目修改,易于调试 常用目录结构: 文件夹 \ 文件 作用 core \ src  主逻辑文件 lib \ commom   公共组件 bin \ starts 启动文件 conf

本章重点: 理解在开发人标准软件时,如何布局项目目录结构,以及注意开发规范的重要性. 一.为什么要有好的目录结构 二.目录组织的方式 三.关于README的内容 四.关于requirements.txt和setup.py ================================================================================== 一.为什么要有好的目录结构 好的设计项目目录结构,就和编码风格一样,是每个程序员都有的风格,但是在流水化标准化作

编码规范 1 前言为确保系统源程序可读性,从而增强系统可维护性,java编程人员应具有基本类似的编程风格,兹制定下述Java编程规范,以规范系统Java部分编程.系统继承的其它资源中的源程序也应按此规范作相应修改. 2 适用范围本文档将作为java编程人员软件开发的编程格式规范.在项目Java部分的编码.测试及维护过程中,要求严格遵守. 3 命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失. 3.1 Package 的命名Packa

1        目的 为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范,保证代码的一致性,便于交流和维护,特制定此规范. 2        范围 本规范适用于开发组全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段. 3        注释规范 3.1      概述 a)       注释要求英文及英文的标点符号. b)       注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描述. c)           每行注释的最大长度为1

6.4 软件开发目录规范 软件(例如:ATM)目录应该包含: 文件名 存放 备注 bin start.py,用于起动程序   core src.py,程序核心功能代码   conf settings.py, 程序配置信息   db db.txt 数据库信息   lib common.py ,存放常用功能   log access.log ,存放记录   start.py : import sys,os #应该把项目的根目录添加到环境变量中BASE_DIR=os.path.dirname(os.p

前言: 这里算是比较实用的一篇了吧,进行了网络安全部署 准备: bmob账号,JSPatch,公钥,私钥,MD5加密,AFNetWorking下载文件 #import <CommonCrypto/CommonDigest.h> #import <BmobSDK/Bmob.h> #import "AFNetworking.h" #import "JPEngine.h" #import "RSA.h" 原理: 1.使用bmob

软件目录结构规范有什么好处: 通过规范化,能够更好的控制软件结构,让程序具有更高的可读性. 项目目录组织结构如下: Foo/ # 项目名 --bin/ # 可执行文件目录 --foo # 可执行程序 --core/ # 主程序目录 --test/ # 测试用例(用于对项目中功能性测试) --__init__.py --test_main.py --__init__.py --main.py # 主程序入口 --conf/ # 配置文件目录 --settings.py #配置文件 --logs/

软件目录结构规范有什么好处: 通过规范化,能够更好的控制软件结构,让程序具有更高的可读性. 项目目录组织结构如下: Foo/ # 项目名 --bin/ # 可执行文件目录 --foo # 可执行程序 --core/ # 主程序目录 --test/ # 测试用例(用于对项目中功能性测试) --__init__.py --test_main.py --__init__.py --main.py # 主程序入口 --conf/ # 配置文件目录 --settings.py #配置文件 --logs/