项目代码规范
1 编写目的
为了更好的提高技术部的工作效率，保证开发的有效性和合理性，并可最大程度的提高程序代码的可读性和可重复利用性，指定此规范。开发团队根据自己的实际情况，可以对本规范进行补充或裁减。
2 整体要求
技术部php开发规范将参照PEAR的规范，基本采用PEAR指定的规范，在其基础上增加、修改或删除部分适合具体开发环境的规范。本规范只针对PHP开发过程中编码的规范，对于PHP开发项目中文件、目录、数据库等方面的规范，将不重点涉及。
本规范包含了PHP开发时程序编码中命名规范、代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、文件头的注释块、CVS标记、URL样例、常量命名等方面的规则。
3 安全规范
3.1存放规则
一般包含文件不需要直接暴露给用户，所以应该放在Web Server访问不到的目录，避免因为配置问题而泄露设置信息。
3.2 安全规则
请参考产品安全检查表。
输入和输出
检查是否做了HTML代码的过滤
可能出现的问题：如果有人输入恶意的HTML代码，会导致窃取cookie, 产生恶意登录表单，和破坏网站
检查变量做数据库操作之前是否做了escape
可能出现的问题：如果一个要写入查询语句的字符串变量包含了某些特殊的字符，比如引号(’ ,”)或者分号(;) 可能造成执行了预期之外的操作。
建议采用的方法：使用mysql_escape_string() 或实现类似功能的函数。
检查输入数值的合法性
可能出现的问题：异常的数值会造成问题。如果对输入的数值不做检查会造成不合法的或者错误的数据存入UDB、存入其它的数据库或者导致意料之外的程序操作发生。
举例：
如果程序以用户输入的参数值做为文件名，进行文件操作，恶意输入系统文件名会造成系统损毁。
核实对cookie的使用以及对用户数据的处理
可能出现的问题：不正确的cookie使用可能造成用户数据泄漏
访问控制
对内部使用的产品或者供合作方使用的产品，要考虑增加访问控制
logs
确保用户的保密信息没有记在log中(例如：用户的密码)
确保对关键的用户操作保存了完整的用户访问记录
https
对敏感数据的传输要采用https
3.3 一些针对PHP的规则
设置register_globals = off (Y!PHP 已经禁止了register_globals，如果你使用Y!PHP 可以不考虑这项设置)
设置error_reporting = E_ALL (Y!PHP 的缺省设置），并且要修正所有的error和warning
将实际的操作放在被引用的文件中。把引用文件放到不可以被直接浏览的目录下
3.4 其它处理规则
3.4.1 对输入参数值进行转义处理
页面接到参数需要SQL操作，这时候需要做转义，尤其需要注意”;”。
如：$a = ” Let’s go ” ;
$sql = “Insert into tmp(col) values(’$a’)” ;
这种情况出现错误的不确定性。
3.4.2 操作大HTML文本
很多时候需要存放一大段HTML文本供页面使用，象用户定制页头页脚等。
需要剔除脚本标记，避免执行恶意php代码。
转换”<"">“号，保证代码完整。
4 编码规范
4.1 命名规范
命名规范参照最底下thinkPHP的命名规范即可。
4.1.3 方法或函数
方法或函数命名遵循以下规则：
a．首字母小写；
b．多个单词间不使用间隔，除第一个单词外，其他单词首字母大写。
例子：function myFunction ()或function myDbOracle ()等。
4.1.4数据库表名
数据库表名命名遵循以下规范：
a．表名均使用小写字母；
d．对于多个单词组成的表名，使用_间隔；
例子：user_info和book_store等
4.1.5数据库字段
数据库字段命名遵循以下规范：
a．全部使用小写；
b．多个单词间使用_间隔。
例子：user_name、rose_price等。
4.2 书写规则
书写规则是指在编写php程序时，代码书写的规则，包括缩进、结构控制等方面规范：
4.2.1 代码缩进
在书写代码的时候，必须注意代码的缩进规则，我们规定代码缩进规则如下：
a．使用tab缩进（对于ultraedit，可以进行预先设置）
例子：
for ( $i=0;$i<$count;$i++ )
{
echo "test";
}
4.2.2 大括号{ }书写规则
在程序中进行结构控制代码编写，如if、for、while、switch等结构，大括号传统的有两种书写习惯，分别如下：
a．{直接跟在控制语句之后，不换行，如
for ($i=0;$i<$count;$i++) {
echo "test";
}
b．{在控制语句下一行，如
for($i=0;$i<$count;$i++)
{
echo "test";
}
其中，a是PEAR建议的方式，但是从实际书写中来讲，这并不影响程序的规范和影响用phpdoc实现文档，所以可以根据个人习惯来采用上面的两种方式，但是要求在同一个程序中，只使用其中一种，以免造成阅读的不方便。
4.2.3 小括号( )和函数、关键词等
小括号、关键词和函数遵循以下规则：
a．不要把小括号和关键词紧贴在一起，要用一个空格间隔；如if ( $a<$b )；
b．小括号和函数名间没有空格；如$test = date("ymdhis")；
c．除非必要，不要在Return返回语句中使用小括号。如Return $a；
4.2.4 ＝符号书写
在程序中=符号的书写遵循以下规则：
a．在=符号的两侧，均需留出一个空格；如$a = $b 、if ($a = = $b)等；
b．在一个申明块，或者实现同样功能的一个块中，要求=号尽量上下对其，左边可以为了保持对齐使用多个空格，而右边要求空一个空格；如下例：
$testa = $aaa;
$testaa = $bbb;
$testaaa = $ccc;
4.2.5 if else swith for while等书写
对于控制结构的书写遵循以下规则：
a．在if条件判断中，如果用到常量判断条件，将常量放在等号或不等号的左边，例如：if ( 6 == $errorNum )，因为如果你在等式中漏了一个等号，语法检查器会为你报错，可以很快找到错误位置，这样的写法要多注意；
b．switch结构中必须要有default块；
c．在for和wiile的循环使用中，要警惕continue、break的使用，避免产生类似goto 的问题；
4.2.6 类的构造函数
如果要在类里面编写构造函数，必须遵循以下规则：
a．不能在构造函数中有太多实际操作，顶多用来初始化一些值和变量；
b．不能在构造函数中因为使用操作而返回false或者错误，因为在声明和实例化一个对象的时候，是不能返回错误的；
4.2.7 语句断行, 每行控制在80个字符以内
在代码书写中，遵循以下原则：
a．尽量保证程序语句一行就是一句，而不要让一行语句太长产生折行；
b．尽量不要使一行的代码太长，一般控制在80个字符以内；
c．如果一行代码太长，请使用类似 .= 的方式断行书写；
d．对于执行数据库的sql语句操作，尽量不要在函数内写sql语句，而先用变量定义sql 语句，然后在执行操作的函数中调用定义的变量；
例子：
$sql = "SELECT username,password,address,age,postcode FROM test_t "; $sql .= " WHERE username='aaa'";
$res = mysql_query($sql);
4.2.8 不要不可思议的数字
一个在源代码中使用了的赤裸裸的数字是不可思议的数字，因为包括作者，在三个月内，没人它的含义。例如：
if (22 == $foo)
{
start_thermo_nuclear_war();
}
else if (19 == $foo)
{
refund_lotso_money();
}
else
{
cry_cause_im_lost();
}
你应该用define()来给你想表示某样东西的数值一个真正的名字，而不是采用赤裸裸的数字，例如：
define("PRESIDENT_WENT_CRAZY", "22");
define("WE_GOOFED", "19");
define("THEY_DIDNT_PAY", "16");
if ( PRESIDENT_WENT_CRAZY == $foo)
{
start_thermo_nuclear_war();
}
else if (WE_GOOFED == $foo)
{
refund_lotso_money();
}
else if (THEY_DIDNT_PAY == $foo)
{
infinite_loop();
}
else
{
happy_days_i_know_why_im_here();
}
4.2.9 true/false和0/1判断
遵循以下规则：
a．不能使用0/1代替true/false，在PHP中，这是不相等的；
b．不要使用非零的表达式、变量或者方法直接进行true/false判断，而必须使用严格的完整true/false判断；
如：不使用if ($a) 或者if (checka()) 而使用if (FALSE != $a)或者if (FALSE != check())
4.2.10 避免嵌入式赋值
在程序中避免下面例子中的嵌入式赋值：
不使用这样的方式：
while ($a != ($c = getchar()))
{
process the character
}
4.2.11 错误返回检测规则
检查所有的系统调用的错误信息，除非你要忽略错误。
为每条系统错误消息定义好系统错误文本，并记录错误LOG。
4.3 程序注释
每个程序均必须提供必要的注释，书写注释要求规范，参照PEAR提供的注释要求，为今后利用phpdoc生成php文档做准备。程序注释的原则如下：
a．注释中除了文件头的注释块外，其他地方都不使用//注释，而使用/* */的注释；b．注释内容必须写在被注释对象的前面，不写在一行或者后面；
4.3.1 程序头注释块
每个程序头部必须有统一的注释块，规则如下：
a．必须包含本程序的描述；
b．必须包含作者；
c．必须包含书写日期；
d．必须包含版本信息；
e．必须包含项目名称；
f．必须包含文件的名称；
g．重要的使用说明，如类的调用方法、注意事项等；
参考例子如下：
//
// +---------------------------------------------------------+
// | PHP version 4.0 |
// +---------------------------------------------------------+
// | Copyright (c) 1997-2001 The PHP Group |
// +---------------------------------------------------------+
// | This source file is subject to of the PHP license, |
// | that is bundled with this packafile LICENSE, and is |
// | available at through the world-web at |
// | https://www.360docs.net/doc/78190057.html,/license/2_02.txt. |
// | If you did not receive a copy of the and are unable to |
// | obtain it through the world-wide-web,end a note to |
// | license@https://www.360docs.net/doc/78190057.html, so we can mail you a immediately. |
// +---------------------------------------------------------+
// | Authors: Stig Bakken |
// | Tomas V.V.Cox |
// | |
// +———————————————————+
//
// $Id: Common.php,v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $ 4.3.2 类的注释
类的注释采用里面的参考例子方式：
/**
* @ Purpose:
* 访问数据库的类，以ODBC作为通用访问接口
* @Package Name: Database
* @Author: Forrest Gump gump@https://www.360docs.net/doc/78190057.html,
* @Modifications:
* No20020523-100:
* odbc_fetch_into()参数位置第二和第三个位置调换
* John Johnson John@https://www.360docs.net/doc/78190057.html,
* @See: (参照)
*/
class Database
{
……
}
4.3.3 函数和方法的注释
函数和方法的注释写在函数和方法的前面，采用类似下面例子的规则：
/**
* @Purpose:
* 执行一次查询
* @Method Name: Query()
*
* @Param: string $queryStr SQL查询字符串
* @Param: string $username 用户名
*
* @Author: Michael Lee
*
* @Return: mixed 查询返回值（结果集对象）
*/
function（$queryStr,$username）
{……}
4.3.4 变量或者语句注释
程序中变量或者语句的注释遵循以下原则：
a．写在变量或者语句的前面一行，而不写在同行或者后面；
b．注释采用/* */的方式；
c．每个函数前面要包含一个注释块。内容包括函数功能简述，输入/输出参数，预期的返回值，出错代码定义。
d．注释完整规范。
e．把已经注释掉的代码删除，或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。
f．
例子：
/**
* @Purpose:
* 数据库连接用户名
* @Attribute/Variable Name: db_user_name
* @Type: string
*/
var db_user_name;
4.4 其他规范（建议）
4.4.1 php代码标记
所有的php程序代码块标记均使用
4.4.2 程序文件名、目录名
程序文件名和目录名命名均采用有意义的英文方式命名，不使用拼音或无意义的字母，同时均必须使用小写字母，多个词间使用_间隔。
4.4.3 PHP项目通常的文件目录结构
具体参照thinkPHP开发手册
以上目录结构是通常的目录结构，根据具体应用的具体情况，可以考虑不用完全遵循，但是尽量做到规范化。
4.4.4 PHP和HTML代码的分离问题
对性能要求不是很高的项目和应用，我们建议不采用PHP和HTML代码直接混排的方式书写代码，而采用PHP和HTML代码分离的方式，即采用模版的方式处理，这样一方面对程序逻辑结构更加清晰有利，也有助于开发过程中人员的分工安排，同时还对日后项目的页面升级该版提供更多便利。
对于一些特殊情况，比如对性能要求很高的应用，可以不采用模版方式。
4.4.5 PHP项目开发中的程序逻辑结构
对于PHP项目开发，尽量采用OOP的思想开发，尤其在PHP5以后，对于面向对象的开发功能大大提高。
在PHP项目中，我们建议将独立的功能模块尽量写成函数调用，对应一整块业务逻辑，我们建议封装成类，既可以提高代码可读性，也可以提高代码重用性。比如，我们通常将对数据库的接口封装成数据库类，有利于平台的移植。
重复的代码要做成公共的库。（除了我们在plug-in产品上遇到的情况，该产品系列有多个相类似的产品，为了尽可能地减少安装包尺寸，不适合将这些产品共用的所有函数做成公共的库）
5 特定环境下PHP编码特殊规范
5.1 变量定义
XXX环境下的php代码编写要求所有的变量均需要先申明后使用，否则会有错误信息，对于数组，在使用一个不确定的key时，比如先进行isset()的判断，然后再使用；比如下面的代码：
$array ＝array();
$var ＝isset($array[3]) ? $array[3] : “”；
5.3 变量的输入输出
在XXX环境下，对web通过GET或者POST方法传递来的参数均要求进行严格的过滤和合法性验证，不推荐使用直接的$_GET、$_POST或者$_REQUEST获取，而通过XXX 的XXX_yiv模块提供的方法获取和过滤处理
1.7命名规范
使用ThinkPHP开发的过程中应该尽量遵循下列命名规范：
?类文件都是以.class.php为后缀（这里是指的ThinkPHP内部使用的类
库文件，不代表外部加载的类库文件），使用驼峰法命名，并且首字母
大写，例如DbMysql.class.php；
?确保文件的命名和调用大小写一致，是由于在类Unix系统上面，对大小
写是敏感的（而ThinkPHP在调试模式下面，即使在Windows平台也会
严格检查大小写）；
?类名和文件名一致（包括上面说的大小写一致），例如 UserAction类
的文件命名是UserAction.class.php， InfoModel类的文件名是
InfoModel.class.php，并且不同的类库的类命名有一定的规范；
?函数、配置文件等其他类库文件之外的一般是以.php为后缀（第三方引
入的不做要求）；
?函数的命名使用小写字母和下划线的方式，例如 get_client_ip；
?方法的命名使用驼峰法，并且首字母小写或者使用下划线“_”，例如
getUserName，_parseType，通常下划线开头的方法属于私有方法；
?属性的命名使用驼峰法，并且首字母小写或者使用下划线“_”，例如
tableName、_instance，通常下划线开头的属性属于私有属性；
?以双下划线“__”打头的函数或方法作为魔法方法，例如 __call 和
__autoload；
?常量以大写字母和下划线命名，例如 HAS_ONE和 MANY_TO_MANY；
?配置参数以大写字母和下划线命名，例如HTML_CACHE_ON；
?语言变量以大写字母和下划线命名，例如MY_LANG，以下划线打头的语
言变量通常用于系统语言变量，例如 _CLASS_NOT_EXIST_；
?对变量的命名没有强制的规范，可以根据团队规范来进行；
?ThinkPHP的模板文件默认是以.html 为后缀（可以通过配置修改）；
?数据表和字段采用小写加下划线方式命名，并注意字段名不要以下划线
开头，例如 think_user 表和 user_name字段，类似 _username 这样
的数据表字段可能会被过滤。
特例：在ThinkPHP里面，有一个函数命名的特例，就是单字母大写函数，这类函数通常是某些操作的快捷定义，或者有特殊的作用。例如，ADSL方法等等，他们有着特殊的含义，后面会有所了解。
另外有一点非常关键，ThinkPHP默认全部使用UTF-8编码，所以请确保你的程序文件采用UTF-8编码格式保存，并且去掉BOM信息头（去掉BOM头信息有很多方式，不同的编辑器都有设置方法，也可以用工具进行统一检测和处理），否则可能导致很多意想不到的问题。
C程序代码大全
//根据半径计算圆的周长和面积#include 项目代码编程规范 1.应用范围 本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）JS代码、HTML代码及数据库设计均应遵守这个规范。同时，也可作为其它项目的参考。 2.设计类和方法 2.1. 创建具有很强内聚力的类 方法的重要性往往比类的重要性更容易理解，方法是指执行一个独立逻辑的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。 之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。 类应该用来将相关的方法组织在一起。 当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。 大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。 创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程序单元。 2.2. 创建松散连接和高度专用的方法 2.2.1.使所有方法都执行专门的任务 每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。 创建专用方法有许多好处。首先调试将变得更加容易。 2.2.2.尽量使方法成为自成一体的独立方法 当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法 系统开发代码规范北京慧点科技开发有限公司 2005年9月 目录 一、Domino网络域及组织的命名................................................................ 错误！未定义书签。 二、Domino服务器的命名............................................................................ 错误！未定义书签。 三、系统验证字的命名................................................................................. 错误！未定义书签。 四、用户和群组的命名................................................................................. 错误！未定义书签。 五、模块数据库的命名................................................................................. 错误！未定义书签。 六、数据库各设计元素的命名..................................................................... 错误！未定义书签。 七、编码规范................................................................................................. 错误！未定义书签。 八、产品开发规范......................................................................................... 错误！未定义书签。 九、提交数据库备份命名规范..................................................................... 错误！未定义书签。 C程序代码大全 This manuscript was revised on November 28, 2020 < 百度文库- 让每个人平等地提升自我 1 程序代码注释编写规范 为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。 一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* (C), MicTiVo International. Co., Ltd. 1.File : . History: Date: Author: Modification: 2. .. *************************************************/ 一、源文件头 源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************************ (C), MicTiVo International. Co., Ltd. FileName: Author: Version : Date: : / /*receive _process() */ 意:与溢出中断写初值不同} 代码编写安全规范 一、本总则提供编码的总体要求与遵循原则。 二、本总则制订是为了规范程序的编码风格，使项目开发过程中所有开发人员的编码有一个良好的、规范的、统一的编码风格，确保在开发成员或开发团队之间的工作可以顺利交接，同时不必花费大力气便能理解已编写的代码，以便继续维护和改进以前的工作。 三、本总则对所有技术开发部编码人有效。 四、本总则对所有开发语言有效，凡任何开发规范与本总则相冲突，以本总则为准。 五、本总则提供各种语言的编码规范，编码人员开发（编码）前应选取相应的语言编码规范进行编码。具体的“开发语言编码规范”请参见附件。 六、若总则附件中无所规范的开发语言规范，请先制订出（一般由项目经理制订）该语言的编码规范后再进行编码。 七、编码命名准则： 1、使用可以准确说明变量/字段/类的完整的英文描述符。例如，采用类似firstName，grandTotal 或CorporateCustomer 这样的名字。禁止使用一些象x1，y1 或fn 这样的名字很简短，输入起来容易，辨别含义困难的命名，使得代码难以理解、维护和改进。 2、采用领域的术语命名。如果用户称他们的“客户”(clients) 为“顾客”(customers)，那么就采用术语Customer 来命名这个类，而不用Client。保证命名使用行业或领域里已经存在着很完美的术语，避免生造词汇。 3、采用大小写混合，提高名字的可读性。一般应该采用小写字母，但类名、接口名以及任何非初始单词的第一个字母要大写，一些特殊场合以具体规范为准。 4、尽量少用缩写，但如果一定要使用，必须使用一个统一遵守的缩写，并且在使用时保持一致。例如，如果要对单词“number”采用缩写，那么可从nbr，no 或者num 中选取一个，采用其中一个（具体是哪个倒无所谓），并且只使用这一种形式。 5、避免使用长名字（最好不超过20 个字母）。避免类似如PhysicalOrVirtualProductOrService 之类的超长命名。 6、避免使用相似或者仅在大小写上有区别的名字。例如，不应同时使用变量名persistentObject 和persistentObjects，以及anSqlDatabase 和anSQLDatabase。 7、避免使用下划线作为名字的首末字母。以下划线为首末字母的名字通常为系统保留，除预处理定义之外，一般不用作用户命名。 八、编码注释准则： 1、必须明确注释的重要性。如果你的程序不值得注释，那么它也不值得运行。 2、注释应该增加代码的清晰度。代码注释的目的是要使代码更易于被同时参与程序设计的开发人员以及其他后继开发人员理解。如果不能被他人所理解，则代码的注释是失败的注释，等同于无注释。 3、避免使用装饰性内容，不要使用象广告横幅那样的注释语句。 项目开发规范文档修订历史记录 1.简介 目的 1、用于规范指导开发组进行开发 2、便于成员间的沟通与交流。 3、有助于项目质量和稳定。 4、为后期维护提供支持 2. 项目开发流程 项目开发过程归纳分为以下步骤： 1. 建立SVN项目版本控制。包括文档，源码，Lib包等。 2. 了解需求，并对需求文档的书写。(见文档结构规则附录)。 3. 详细设计文档。(见文档结构规则附录)。 功能模块设计，重要模块的算法设计。 数据库设计等。 根据需求定义开发平台及环境。 4. 编码。 搭建开发平台，配置开发环境。 编码。 单元测试案例。 5. 书写软件安装手册文件，数据库脚本文件，以及注意事项(release notes)。 6. 交互测试组测试。根据测试组测试结果是否回归第4步（测试回归最好不要超过2 次）。 7. 测试通过，交付上线使用。 维护手册 使用手册 3. 代码规范 Java 代码规范 3.1.1 Java类名 类名可由：英文字母，数字，下划线组成。（数字，下划线不能够开头） 类名由一个或者多个单词组成。单词通常要求简洁明了达意。能够通过类名能够大致了解此类的作用和用途。 类名要求首字母大写，多个单词组成类名时，单词的首字母要求大写。 建议：类名不要过于简单或者太长。可以对单词采用简化的名称：入： Number 简化为：num 。 3.1.2 Java类结构 类仅作为数据结构，没有行为，他封装了一组或者相似的一些行为方法。所以一个类尽量功能单一，或者功能类似共有行为的。一个类不要过于庞大。 通常情况下： 一般逻辑类中应该有构造方法和main方法，main方法中应该有测试代码。 每个类应该有 toString() 方法。 3.1.2.1 包和引入语句 在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。 报名的定义全部是小写字母。具体定义依据项目而定。 引入包时候，同一类型的归纳到一块，用空行隔开。例如： import 3.1.2 类注释 Java类开头应该有相应的注释：类版本描述，作者签名，日期时间，公司备注，类的功能作用相关描述等。（详细查看：注释） 3.1.2.2 类成员变量 a) 类变量要求放在类的开始声明。一行声明一个。 b) 变量名称首字母要求小写。其他命名规则类似与类名。 c) static , final 类型的变量，字母要求全部大写。 d) 尽量在声明局部变量的同时初始化。 e) 避免局部变量和成员变量同名，覆盖了成员变量。 f) 尽量变量私有化，缩小变量的作用域。 3.1.2.3 类成员方法 a) 方法名命名规则类似于成员变量命名规则。 b) 成员方法尽量私有化。 数控机床标准G、M代码 一．准备功能字G 准备功能字是使数控机床建立起某种加工方式的指令，如插补、刀具补偿、固定循环等。G功能字由地址符G和其后的两位数字组成，从G00—G99共100种功能。JB3208-83标准中规定如下表： 代码功能 作用范 围 功能 代码 功能作用范围功能 G00 点定位 G50 * 刀具偏置0/- G01 直线插补 G51 * 刀具偏置+/0 G02 顺时针圆弧插补 G52 * 刀具偏置-/0 G03 逆时针圆弧插补 G53 直线偏移注销 G04 * 暂停 G54 直线偏移 X G05 * 不指定 G55 直线偏移Y G06 抛物线插补 G56 直线偏移Z G07 * 不指 定 G57 直线偏移XY G08 * 加速 G58 直线偏移XZ G09 * 减速 G59 直线偏移YZ G10-G16 * 不指定 G60 准确定位（精） G17 XY平面选 择 G61 准确定位（中） G18 ZX平面选择 G62 准确定位（粗） G19 YZ平面选择 G63 * 该丝 G20-G32 * 不指定 G64-G67 * 不指定 G33 螺纹切削，等螺距 G68 * 刀具偏置，内角 G34 螺纹切削，增螺距 G69 * 刀具偏置，外角 G35 螺纹切削，减螺距 G70-G79 * 不指定 G36-G39 * 不指定 G80 固定循环注销 G40 刀具补偿/刀具偏置 注销 G81-G89 固定循环 G41 刀具补偿--左 G90 绝对尺寸 G42 刀具补偿-- 右 G91 增量尺寸 G43 * 刀具偏置--正 G92 * 预置寄存 G44 * 刀具偏置--右 G93 进给率，时间倒数 G45 * 刀具偏置+/+ G94 每分钟进给 G46 * 刀具偏置+/- G95 主轴每转进给 G47 * 刀具偏置-/- G96 恒线速 度 G48 * 刀具偏置-/+ G97 每分钟转数（主轴） G49 * 刀具偏置0/+ G98-G99 * 不指定 注：*表示如作特殊用途，必须在程序格式中说明二．辅助功能字M ------------------------------------------------------------------------摘自宋鲁生程序设计大赛 乘法口诀表 #include 用一维数组统计学生成绩 #include 命名规范： 1.所有的标识都只能使用ASCII字母（A-Z或a-z）、数字（0-9）和 下划线”_”。 2.一个唯一包名的前缀总是用全部小写的字母。 3.类名是一个名词，采用大小写混合的方式，每个单词的首字母大 写。 4.接口的大小写规则与类名相似。 5.方法名是一个动词或是动词词组，采用大小写混合的方式，第一 个单词的首字母小写，其后单词的首字母大写。 6.变量名的第一个字母小写，任何中间单词的首字母大写，变量名 应简短且可以顾名思义，易于记忆。避免单个字符的变量名，除非是一次性的临时变量。 7.常量的声明应该全部大写，每个单词之间用”_”连接。 注释规范： 1.注释尽可能使用”//”,对于所有的Javadoc的注释使用/***/，而 临时对代码块进行注释应尽量使用/**/。 2.所有的源文件都应该在开头有一个注释，其中列出文件名、日期 和类的功能概述。每个方法必须添加文档注释（main除外）。 3.每个属性必须加注释。 4.代码中至少包含15%的注释。 5.注释使用中文。 缩进排版规范： 1.避免一行的长度超过60个字符。 2.使用Eclipse源代码的格式化功能完成代码的缩进排版。 文件名规范： 1.一个Java源文件只能储存一个Java类。 2.文件名与Java类相同。 3.一个类文件不超过200行。 声明规范： 1.一行声明一个变量。 2.不要将不同类型变量的声明放在同一行。 3.只在代块的开始处声明变量。 4.所有的变量必须在声明时初始化。 5.避免声明的局部变量覆盖上一级声明的变量。 6.方法与方法直接以空行分隔。 语句规范： 1.每行至少包含一条简单语句。 2.在return语句中，返回值不使用小括号”()”括起来。 3.If月总是用{和}括起来。 4.在for语句的初始化或者更新子句中，避免因使用3个以上变量， 而导致复杂度提高。 5.当switch的一个case顺着往下执行时（因为没有break），通常 应在break语句的位置添加注释。 项目团队开发规范 修订历史记录 目录 1引言 (6) 1.1 编写目的 (6) 1.2 预期读者 (6) 1.3 编写背景 (6) 2概述 (7) 2.1 目标 (7) 2.2 修改及完善 (7) 3详细规范 (7) 3.1 使用的工具 (7) 3.2 框架设计 (7) 3.3 包目录 (8) 3.4 编码规范 (10) 3.4.1 目的 (10) 3.4.2 依据 (10) 3.4.3 具体规范 (10) 3.4.3.1 编码风格 (10) 3.4.3.1.1 缩进 (10) 3.4.3.1.2 空格 (11) 3.4.3.1.3 对齐 (12) 3.4.3.1.4 空行 (12) 3.4.3.1.5 代码长度 (13) 3.4.3.1.6 行数 (13) 3.4.3.1.7 注释 (14) 3.4.3.2 代码效率 (17) 3.4.3.2.1 综述 (17) 3.4.3.2.2 具体实现 (17) 3.4.3.3 异常处理 (17) 3.4.3.3.1 处理CHECK 异常与UNCHECK异常 (17) 3.4.3.4 程序调试 (17) 3.4.4 日常交流 (18) 3.4.4.1 互相促进 (18) 1引言 1.1 编写目的 本文档作为项目团队开发规范的说明书，描述了项目开发过程中的使用的工具，框架，代码编写规范及注意问题，作为项目团队建设，开发及测试工作的依据。 1.2 预期读者 本文档的预期读者包括以下几类： ?项目组长 ?项目组全体成员 1.3 编写背景 根据公司现有的开发状况，决定组件稳定的项目开发团队，制定全体团队成员共识的开发规范，有助于提高项目开发的效率、项目团队整体水平的提升。 C 经典程序代码大全 #include const float PI= 3.1416; //声明常量(只读变量)PI为 3.1416 float fCir_L(float); //声明自定义函数fCir_L()的原型 float fCir_S(float); //声明自定义函数fCir_S()的原型 //以下是main()函数 main() { float r,l,s; //声明3个变量 cout>r; //键盘输入 l=fCir_L(r); //计算圆的周长，赋值给变量l s=fCir_S(r); //计算圆的面积，赋值给变量s cout=0.0) //如果参数大于0，则计算圆的周长 z=2*PI*x; return(z); //返回函数值 } //定义计算圆的面积的函数fCir_S() float fCir_S(float x) { float z=- 1.0; //声明局部变量 if (x>=0.0) //如果参数大于0，则计算圆的面积 z=PI*x*x; return(z); //返回函数值 } /* Program: P1- 2.CPP Written by: Hap Date written: 02:11:10 */ #include void main(void) { double s1,s2,s3; s1= 1.5; /* 对变量s1赋值*/ cout main() { double r= 1.0; cout>r; //键盘输入 l=2* 3.1416*r; //计算圆的周长，赋值给变量l cout //包含iostream.h头文件 void main() { //输出字符常量.变量和字符串 char c1= A ; cout //包含iostream.h头文件 main() { //输入输出字符 char c; cin>>c; cout>n; cout>x; cout>n; cout>c>>n>>x; cout //包含iostream.h头文件 main() { //声明整型变量 int a,b; //从键盘上为整型变量赋值cout>a; cout>b; //整型数的算术运算 cout //包含iostream.h 头文件 main() { //声明变量，并初始化 int a=010,b=10,c=0X10; //以进制形式显示数据 cout>a; cout>b; cout>c; cout //包含iostream.h头文件 #include // iomanip.h头文件包含setprecision()的定义 main() { //float型变量的声明.输入.计算和输出 float fx,fy; cout>fx; cout>fy; cout>dx; cout>dy; cout //包含iostream.h 头文件 main() { //字符类型变量的声明 char c1= A ; char c2; //字符数据的运算及输出 c2=c1+32; cout>c1>>c2; cout //包含iostream.h头文件 main() { char c1= \a ,TAB= \t ; //阵铃一声 cout //包含iostream.h头文件 main() ? 软件销售代理合同范本软件代码编写规范 草稿 2005.2 ? 软件销售代理合同范本 1 命名规则 https://www.360docs.net/doc/78190057.html,命名规则 一致的命名模式是托管类库中可预知性与可发现性最重要的元素之一。对这些命名指南广泛的使用和理解将消除许多最常见的用户问题。本主题提供.NET Framework 类型的命名指南。对于每个类型，还应该注意关于大写样式、区分大小写和措词的一些通用规则。 1.1.1大写样式 描述用于在类库中命名标识符的Pascal 大小写、Camel 大小写和全部大写样式。 使用下面的三种大写标识符约定。 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如： B ack C olor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： b ack C olor 大写 标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如： System.IO System.Web.UI 可能还必须大写标识符以维持与现有非托管符号方案的兼容性，在该方案中所有大写字母经常用于枚举和常数值。一般情况下，在使用它们的程序集之外这些字符应当是不可见的。 下表汇总了大写规则，并提供了不同类型的标识符的示例。 标识符大小写示例 类Pascal AppDomain 枚举类型Pascal ErrorLevel 枚举值Pascal FatalError 事件Pascal ValueChange 异常类Pascal WebException 注意总是以Exception后缀结尾。 只读的静态字段Pascal RedValue 接口Pascal IDisposable 注意总是以I 前缀开始。 方法Pascal ToString 命名空间Pascal System.Drawing 参数Camel typeName 属性Pascal BackColor 1. 数控程序中字母的含义 O：程序号，设定程序号 N：程序段号，设定程序顺序号 G：准备功能 X/Y/Z ：尺寸字符，轴移动指令 A/B/C/U/V/W：附加轴移动指令 R：圆弧半径 I/J/K：圆弧中心坐标（矢量） F：进给，设定进给量 S：主轴转速，设定主轴转速 T：刀具功能，设定刀具号 M：辅助功能，开/关控制功能 H/D：刀具偏置号，设定刀具偏置号 P/X：延时，设定延时时间 P：程序号指令，设定子程序号（如子程序调用：M98P1000） L：重复，设定子程序或固定循环重复次数（如：M98 P1000 L2，省略L代表L1）P/W/R/Q：参数，固定循环使用的参数(如：攻牙G98/(G99)G84 X_ Y_ R_ Z_ P_ F_) 2. 常用G代码解释 G00：定位或快速移动 G01：直线插补 G02：圆弧插补/螺旋线插补CW G03：圆弧插补/螺旋线插补CCW G04：停留时间或延时时间 如：G04 X1000(或G04 X1.0) G04 P1000表示停留1秒钟 G09：准确停止或精确停止检查（检查是否在目标范围内） G10：可编程数据输入 G17：选择XPYP 平面 XP：X 轴或其平行轴 G18：选择ZPXP 平面 YP：Y 轴或其平行轴 G19：选择YPZP 平面 ZP：Z 轴或其平行轴 G20：英寸输入 G21：毫米输入 G28：返回参考点检测 格式：G91/(G90) G28 X__ Y__ Z__ 经过中间点X__ Y__ Z__返回参考点(绝对值/增量值指令) G29：从参考点返回 G91/(G90) G29 X__ Y__ Z__ 从起始点经过参考点返回到目标点X__ Y__ Z__的指令(绝对值/增量值指令) G30 返回第2，3，4 参考点 G91/(G90) G30 P2 X__ Y__ Z__；返回第2 参考点（P2 可以省略。） G91/(G90) G30 P3 X__ Y__ Z__；返回第3 参考点 安全代码编写规范 一、编写目的 为加强武汉楚烟信息技术有限公司在软件开发中的安全规范要求，减少应用上线后带来潜在的安全风险，特拟定安全代码编写规范。二、使用范围 本规范适用于武汉楚烟信息技术有限公司承建的各类开发类的软件类项目。 三、应用安全设计 在总体架构设计阶段，需明确与客户方沟通确认甲方对于软件安全的相关要求，对于有明确安全要求的（例如授权管理要求、用户认证要求、日志审计要求等），须在设计文档中予以详细说明。对于互联网应用，务必明确网络安全、应用安全、数据安全相关的安全防护手段。 在技术架构上，应采用表现层、服务层、持久层分类的架构，实现对底层业务逻辑进行有效隔离，避免将底层实现细节暴露给最终用户。 在部署架构上，应采用应用服务器、数据库服务器的分离部署模式，在应用服务器被攻击时，不会导致核心应用数据的丢失。如软件产品具备有条件时，应优先采用加密数据传输方式（例如https协议）。 在外部接口设计方面，应采用最小接口暴露的原则，避免开发不必要的服务方法带来相关安全隐患，同时对于第三方接口，应共同商定第三方接入的身份认证方式和手段。 四、应用安全编码 4.1. 输入验证 对于用户输入项进行数据验证，除常见的数据格式、数据长度外，还需要对特殊的危险字符进行处理。特殊字符包括<> " ' % ( ) & + \ \' \"等 对于核心业务功能，除在客户端或浏览器进行数据验证外，还必须在服务器端对数据进行合法性检验，规避用户跳过客户端校验，直接将不合规的数据保存到应用中。 对于浏览器重定向地址的数据，需要进行验证核实，确认重定向地址是否在可信，并且需要对换行符（\r或\n）进行移除或者替换。 4.2. 数据输出 对需要输出到用户浏览器的任何由用户创造的内容，应在输出到浏览器之前或持久化存储之前进行转义(至少对<>转义为< >)以防止跨站攻击脚本(XSS)。对于无法规避的HTML片段提交，需对
项目编码规范
系统开发代码规范
C程序代码大全
程序代码注释编写规范
代码编写安全规范
项目开发及编码规范
数控编程G、M、T、S代码大全(精选.)
C语言代码大全
Java代码编写规范(参考)
java项目团队开发规范
C 经典程序代码大全
软件代码编写规范
CNC加工中心程序代码大全
安全代码编写规范