节选自“Discuz! 开放平台的编码规范”(通用的)

http://open.discuz.net/?ac=document&page=dev_coderule

本文字体字号大小(只针对本文编辑器):

项目描述                             字号          加重与否             例

重要内容标题                   18pt        重色                I. 代码编写规范,“

一般描述性文字                13px        不加重色           序的内容

一般描述性文字标题           13px        重色                副标题“代码标记

(注:行与行间间隔,保持一致,列头保持一致;每行内容长度控制在屏宽的2/3左右)

序:

每种开发语言的编码规范都是不同的,但有的又是相通的。不管是你是做 php(开发)或者 java,又或者 android / ios。

编码规范度,是一个码农经验的体现。编码规范的重要性,自然不言而喻。

下面看看这篇文章中,我们可以借鉴哪些编码上的想通的约定。

当然,限于篇幅,编码规范是一项系统的工程,本篇只是抛砖引玉,还有哪些优秀的编码习惯你也可以在评论中补充。

本篇中讲到的编码规范方向:

代码编写;数据库设计;其他方面

(注:本篇只是对原文内容的整理,限于一些细则方面,不再赘述.)

I. 代码编写规范

1.   代码标记

2.     注释

3.       书写规范

4.   命名规范

5.   变量/逻辑检查

6.   安全性

7.   兼容性

8.   代码重用

9.   其他细节  

II.数据库设计规范

1.   表结构

2.   字段

3.   性能  

III.其他方面

1.       跨平台

2.         项目目录命名

3.    文件在项目位置引用

 

时间: 2024-08-12 01:38:25

节选自“Discuz! 开放平台的编码规范”(通用的)的相关文章

前端编码规范 -- 通用篇

前言 本系列意在增强团队的开发协作,提高代码质量和打造开发基石的编码风格规范. 我们知道,当一个团队开始指定并实行编码规范的话,错误就会变得更加显而易见.如果一段特定的代码不符合规范的话,它有可能只是代码风格错误,而也有可能会是bug.早期指定规范就使得代码审核得以更好的开展,并且可以更精确的地定位到错误.只要开发者们能够保证源代码源文件都严格遵循规范,那接下去所使用的混淆.压缩和编译工具则可投其所好不尽相同. 不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的. 文件/资源

Discuz! 的编码规范

http://open.discuz.net/?ac=document&page=dev_coderule 前言 本规范由编程原则组成,融合并提炼了开发人员长时间积累下来的成熟经验,意在帮助形成良好一致的编程风格. 适用范围 如无特殊说明,以下规则要求完全适用于Discuz!项目,同时也可大部分适用于COMSENZ旗下其他PHP项目. 标准化的重要性和好处 当一个软件项目尝试着遵守公共一致的标准时,可以使参与项目的开发人员更容易了解项目中的代码.弄清程序的状况.使新的参与者可以很快的适应环境,防

软件体系结构:二维分层、模块化和开放平台

http://www.cnblogs.com/baihmpgy/archive/2011/05/22/2053742.html 先引出几个问题.首先,对于分层,如何来分层?仅仅纵向分层是否够用了?什么是“二维分层”呢?一提到模块化,很多人会说“我们的系统就是基于模块化来构建”,稍微一多问,要么和分层差不多,要么就说我们是基于一个又一个的dll文件来实现模块化的,那应该怎样才算模块化呢?“开放平台”怎么回事? 关于“二维分层”软件体系结构的提法比较少见.不过,对于分层软件体系结构,估计是个傻子都知

支付宝开放平台创建应用、用户授权及应用授权

学习 · 分享 银盒子技术团队分享平台 支付宝开放平台创建应用.用户授权及应用授权 一.创建应用 1.登录蚂蚁金服开放平台(open.alipay.com), 2.进入开发者中心中,创建登记您的应用,并提交审核,审核通过后会为您生成应用唯一标识(APPID)<开放平台应用创建指南> 二.配置密钥 1. 开发者调用接口前需要先生成RSA密钥,RSA密钥包含应用私钥(APP_PRIVATE_KEY).应用公钥(APP_PUBLIC_KEY). 2.生成密钥后在开放平台开发者中心进行密钥配置,配置完

百度AI开放平台- API实战调用

百度AI开放平台- API实战调用 一.      前言 首先说一下项目需求. 两个用户,分别上传了两段不同的文字,要计算两段文字相似度有多少,匹配数据库中的符合条件的数据,初步估计列出来会有60-100条左右,不会更多,只会更少.最终的需求是:从这些匹配结果中找到相似度较高的那些条目. 自己编写算法来实现是一个很大的工程,涉及到自然语言处理的一些方面,比较复杂.于是上网搜了搜,发现百度开放平台的自然语言处理可以免费调用,而且每天有10W的调用次数,对我的小项目来说正好满足.但是,在往下翻的时候

[转载]Objective-C开发编码规范:4大方面解决开发中的规范性问题

Objective-C 编码规范,内容来自苹果.谷歌的文档翻译,自己的编码经验和对其它资料的总结. 概要 Objective-C 是一门面向对象的动态编程语言,主要用于编写 iOS 和 Mac 应用程序.关于 Objective-C 的编码规范,苹果和谷歌都已经有很好的总结: Apple Coding Guidelines for Cocoa Google Objective-C Style Guide 本文主要整合了对上述文档的翻译.作者自己的编程经验和其他的相关资料,为公司总结出一份通用的编

利用腾讯云服务器进行微校开放平台开发

版权声明:本文由追梦者原创文章,转载请注明出处: 文章原文链接:https://www.qcloud.com/community/article/225 来源:腾云阁 https://www.qcloud.com/community 微校开放平台概述 腾讯微校是专注高校领域的公众号第三方平台,目前已接入公众号超过3万个,精准覆盖大学生超过2000万.通过微校开放平台,开发者可以轻松的直接向上千万大学生提供服务,公众号运营者也可以通过本文档来帮助拓展开发. 微校开放平台主要用于指导开发者如何借助微

QQ空间开放平台开发教程-SDK和API的使用

今天闲着没事给大家说说腾讯开放平台我用的是OpenAPI V3.0的PHPSdk,大家可以下载一下,现在就简单的说明一下使用因为我也没有应需求只是看一下应该怎么使用而已,大家从官方下载Sdk,然后在应用管理中心-应用信息管理-平台信息管理然后输入自己的应用的url我的是http://www.lingphp.com/index.php作为调试 那大家简单来学一下吧!把下载的Test_OpenApiV3.php重新命名为index.php <?php /** * OpenAPI V3 SDK 示例代

Objective-C 编码规范

Objective-C 编码规范,内容来自苹果.谷歌的文档翻译,自己的编码经验和对其它资料的总结. 概要 Objective-C 是一门面向对象的动态编程语言,主要用于编写 iOS 和 Mac 应用程序.关于 Objective-C 的编码规范,苹果和谷歌都已经有很好的总结: Apple Coding Guidelines for Cocoa Google Objective-C Style Guide 本文主要整合了对上述文档的翻译.作者自己的编程经验和其他的相关资料,为公司总结出一份通用的编