用过IDE或看过其他源码的小伙伴们应该都见过类似下面这样的注释   /** * 递归获取所有游戏分类 * @param int $id * @return array */ 看得多了就大概知道了一些规律.为了使自己的代码更加规zhuang范bi,也开始有样学样地写着这些注释 其实这种注释格式是有自己的名字的,它就叫—— PHPDOC PHPDoc 是一个 PHP 版的 Javadoc.它是一种注释 PHP 代码的正式标准.它支持通过类似 phpDocumentor 这样的外部文档生成器生成 AP…

1.变量:将程序中运行的中间值临时存储起来,以便下次使用. 2.变量命名规范:数字.字母.下划线.建议驼峰体.变量名具有可描述性.不能使用中文和拼音.不能数字开头和使用关键字('and', 'as', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', 'else', 'except', 'exec', 'finally', 'for', 'from', 'global', 'if', 'import', 'in', 'is…

1.注释 1)单行注释     # 2) 多行注释   前后三个单引号或双引号   ‘’‘  ...  '''    """  ...""" 3)中文编码声明注释 # -*- coding:编码  -*- 或  # coding=编码 若采用UTF-8编码,则设置为urf-8;若使用GBK编码,则使用gbk 或cp936 2.代码缩进 使用冒号区分代码之间的层次. 四个空格或一个Tab键作为缩进.推荐用4个空格. 可以在IDE设置快捷键,进行缩进…

PHP 开发规范1.3.3 一.编程规约 (一) 命名风格 [强制]代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式. 说明: 正确的英文拼写和语法可以让阅读者易于理解,避免歧义.注意,即使纯拼音命名方式 也要避免采用. 正例: alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文. 反例: DaZhePromotion [打折] / getPingfenByName()[评分] [强制]方法名.参数名.成员变量.局部变量都统一…

文档注释,无非“//”和“/**/”两种 ,自己写代码,就那么点,适当写几句就好了:但是一个人总有融入团队的一天,团队的交流不是那几句注释和一张嘴能解决的,还需要通用的注释标准. PHPDoc是PHP文档注释的一个标准,可以帮助我们在注释文档时有规范,查看别人的代码时更方便.下面的表格是我翻译的WIKI上的PHPDoc,个人英文水平有限,可以参照原文. 文档翻译自:http://en.wikipedia.org/wiki/Phpdoc 标记 用途 描述 @abstract   抽象类的变量和方法…

<?php /** * start page for webaccess * * PHP version 5 * * @category PHP * @package PSI_Web * @author Michael Cramer <BigMichi1@users.sourceforge.net> * @copyright 2009 phpSysInfo * @license http://opensource.org/licenses/gpl-2.0.php GNU General…

  什么是标识符符? 凡是可以由自己命名的地方都称为修饰符. 例: 项目名 ,包名 ,类名 .方法名 2.   命名规范. ①    不可使用java关键字和保留字,但是可以包含关键字和保留字. ②    可以使用26个字母大小写,数字0-9,$和_. ③    可以使用数字,但不可放在首位. ④    长度理论上没有限制,但命名最好能反映出其作用,遵循”驼峰形式”,见命知意. 例:写一个ajax的项目实例, 项目名:ajaxtest 包名:com.liu.ajax 类名:AjaxDemo 3.…

Eclipse作为JavaIDE(Integrated Development Environment,集成开发环境),可以通过设置自动添加Javadoc注释信息,如@author 作者名.@version 版本标识.@date 日期等,在创建类或新增方法时会自动添加注释信息.关于java如何生成javadoc文档可参考下文.下面将会为大家介绍如何在Eclipse中设置Java注释模板.   3Eclipse规范注释及注释文档的生成   工具/原料   Eclipse Oxygen Releas…

PHP 高级程序设计学习笔记20140612 软件开发中的一个重要环节就是文档编写.他可以帮助未来的程序维护人员和使用者理解你在开发时的思路.也便于日后重新查看代码时不至于无从下手.文档还有一个重要的作用,在不用了解要访问对象的细节情况下也能很好的在对象之间进行交互.文档的编写有一些成熟的行业标准格式,遵守这些行业标准将有助于创建易于阅读的代表,并使自动生成手册成为可能. 编码规范 编码规范可能很多开发人员都有各自的观点也意见,且大家不尽相同.其实只要团队成员之间达成一致,遵循同一个标准就好.…

对于一个开发人员,文档总是最感到头疼的事情之一.而且,很可能你对待文档会采取截然不同的2种态度: 当你使用别人的代码库的时候,最希望得到的是它的技术文档,尤其是当时间很紧,而你又不得不硬着头皮去读那些生涩的代码的时候. 当写你自己的程序的时候,最不希望做的事情却是给它编写专门的技术文档,你会以种种理由给自己开脱:我的代码已经足够清晰了,完全不用再为它重新编写文档了…… 也许是为了缓解这种矛盾,有很多工具可以帮助你,通过从源代码中抽取相应的注释,可以自动生成相应的api文档.java中的javad…

(转载:https://blog.csdn.net/alexdream/article/details/2213313) 这些年来多从事Linux下PHP和C相关的开发,带过很多项目和团队,下面是根据经验整理的PHP编码规范,可以用作给大家的范例和参考,根据需要进行取舍和修改! 目录1 编写目的2 整体要求3 安全规范3.1 包含文件3.1.1 命名规则3.1.2 存放规则3.2 安全规则3.3 一些针对PHP的规则3.4 其它处理规则3.4.1 对输入参数值进行转义处理3.4.2 操作大HTM…

phpDocumentor, 分为文档性注释, 和 非文档性注释; 命令为: phpdoc -h, -f, -d.... 提取/ 生成 程序的注释文档, 实际上有很多种工具, 如: doc++, doxygen = dox-y-gen= doxy-generate, ..., 而php的注释文档生成工具是: PhpDocumentor... 安装好pear, phpdoc后,会在/usr/share/中生成pear和pear-data两个目录. 其中pear下是它的核心代码文件,包括inc文件和…

这些年来多从事Linux下PHP和C相关的开发,带过很多项目和团队,下面是根据经验整理的PHP编码规范,可以用作给大家的范例和参考,根据需要进行取舍和修改! (可能最新的一些php5的规范不够完整,今后有机会保持更新!) 目录1 编写目的2 整体要求3 安全规范3.1 包含文件3.1.1 命名规则3.1.2 存放规则3.2 安全规则3.3 一些针对PHP的规则3.4 其它处理规则3.4.1 对输入参数值进行转义处理3.4.2 操作大HTML文本 4 编码规范4.1 命名规范4.1.1 变量命名4…

这些年来多从事Linux下PHP和C相关的开发,带过很多项目和团队,下面是根据经验整理的PHP编码规范,可以用作给大家的范例和参考,根据需要进行取舍和修改! (可能最新的一些php5的规范不够完整,今后有机会保持更新!) 目录1 编写目的2 整体要求3 安全规范3.1 包含文件3.1.1 命名规则3.1.2 存放规则3.2 安全规则3.3 一些针对PHP的规则3.4 其它处理规则3.4.1 对输入参数值进行转义处理3.4.2 操作大HTML文本 4 编码规范4.1 命名规范4.1.1 变量命名4…

1.开发背景 最近一直在写dubbo接口,以前总是用word文档写接口描述然后发给别人.现在太多了,而且跟别人对接联调的人家急着用,根本没时间去写word文档.那就想想怎么用doc文档注释自动生成接口文档了.本来以前对这一块有点印象,但是并不熟悉,加上没有很强烈的要去使用的意图,所以一直没有弄.今天要感谢公司的大神,大家都叫他欧神,神一样的男人.让我用文档注释.然后就知道怎么弄了,以下是生成的流程.   2.生成方法 先说生成的方法吧,免得一开始将注释规范可能读者觉得比较繁琐,而且注释规范基本上…

[java] 注释以及javadoc使用简介-汇率换算器的实现-插曲3 // */ // ]]>   [java] 注释以及javadoc使用简介-汇率换算器的实现-插曲3 Table of Contents 1 系列文章地址 2 本文动机介绍 3 javadoc介绍 4 注释分类–按范围分 5 常用的标签 6 针对包的注释 7 针对类和接口的注释 8 针对方法的注释 9 其他字段的注释 10 在"汇率转换器"源代码中添加注释 11 执行javadoc, 并且使得中文正常显示 1…

HTML和CSS编码规范内容 一.HTML规范 二.CSS规范 三.注意事项: 四.常用的命名规则 五.CSS样式表文件命名 六.文件命名规则 一.HTML规范: 1.代码规范 页面的第一行添加标准模式声明 <!DOCTYPE html> 代码缩进:tab键设置四个空格(通常在软件右下角设置相应空格大小) html中除了开头的DOC和 'UTF-8'或者head里特殊情况可以大写外,其他都为小写,css类都为小写 建议为 html 根元素指定 lang 属性,从而为文档设置正确的语言 lang…

Wrod下载           C#代码开发规范     文件状态: [√] 草稿 [  ] 正式 [  ] 修改 文件标识: 当前版本: 1.1 作    者: Empty 联系电话: 最后更新: 2014-04-07   版本记录 日期 版本号 作者 说明 2014-4-2 1.0 Empty 创建 2014-4-7 1.1 Empty 添加前言.注释规范与编码规范 目    录   1.      前言... 4 1.1        编写目的... 4 1.2        适用范围.…

hbh 开发规范文档 一:目的 使本组织能以标准的,规范的方式设计和编码.通过建立编码规范,以使每个开发人员 养成良好的编码风格和习惯:并以此形成开发小组编码约定,提高程序的可靠性,可读性, 可修改性,可维护性和一致性等,增进团队间的交流,并保证软件产品的质量. 二:代码组织与风格 1:长度:为便于阅读和理解,单个函数的有效代码长度当尽量在100行以内(不包括注行), 当功能模块过大时往往采用使用子函数将相应的功能抽取出来,这也有利于提高代码的重用度. 2:间隔:类,方法及功能块间等应以一个空行…

下载原版阿里JAVA开发手册  [阿里巴巴Java开发手册v1.2.0] 本文主要是对照阿里开发手册,注释自己在工作中运用情况. 本文难度系数为一星(★) 码出高效.码出质量. 代码的字里行间流淌的是软件生命中的血液,质量的提升是尽可能少踩坑,杜绝踩重复的坑,切实提升质量意识.另外,现代软件架构都需要协同开发完成,高效协作即降低协同成本,提升沟通效率,所谓无规矩不成方圆,无规范不能协作.众所周知,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全.试想如果没有限速,没有红绿灯,谁还敢上…

  什么是标识符符? 凡是可以由自己命名的地方都称为修饰符. 例: 项目名 ,包名 ,类名 .方法名 2.   命名规范. ①    不可使用java关键字和保留字,但是可以包含关键字和保留字. ②    可以使用26个字母大小写,数字0-9,$和_. ③    可以使用数字,但不可放在首位. ④    长度理论上没有限制,但命名最好能反映出其作用,遵循"驼峰形式",见命知意. 例:写一个ajax的项目实例, 项目名:ajaxtest 包名:com.liu.ajax 类名:AjaxDe…

一.简明概述 1.编码 如无特殊情况, 文件一律使用 UTF-8 编码 如无特殊情况, 文件头部必须加入#-*-coding:utf-8-*-标识 2.代码格式 2.1.缩进 统一使用 4 个空格进行缩进 2.2.行宽 每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ,但最长不得超过 120) 理由: 这在查看 side-by-side 的 diff 时很有帮助 方便在控制台下查看代码 太长可能是设计有缺陷 2.3.引号 简单说,自然语言使用双引号,机器标示使用单引号,因此 代…

目录 一 代码编排 二 文档编排 三 空格使用 四 注释 五 文档描述 六 命名规范 七 编码建议 代码编排 1缩进,4个空格,不用tab键(因为可能不同系统tab的空格数不一定) 2每行最大长度79,换行使用反斜杠,最好用圆括号 3类和top_level函数定义之间空两行:类中的方法之间空一行:函数内逻辑无关的段落之间空一行 二.文档编排 1.模块内容顺序:模块说明和docstring-import-globals&constants-其它定义.其中,import部分按照标准.三方.和自己编写…

  Java开发手册 版本号 制定团队 更新日期 备  注 1.0.0 阿里巴巴集团技术部 2016.12.7 首次向Java业界公开 一.编程规约 (一) 命名规约 1.   [强制]所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束.反例: _name / __name / $Object / name_ / name$ / Object$ 2.   [强制]所有编程相关的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式.说明:正确的英文拼写和语法可以让阅…

Alpha代码规范.冲刺任务与计划 团队名称: 云打印 作业要求: Alpha代码规范.冲刺任务与计划 作业目标:代码规范.冲刺任务与计划. 团队队员 队员学号 队员姓名 个人博客地址 备注 221600412 陈宇 http://www.cnblogs.com/chenyuu/ 队长 221600411 陈迎仁 https://www.cnblogs.com/yinen/ 221600409 蔡森林 https://www.cnblogs.com/csl8013/ 221600401 陈诗娴…

编程规范 1.1. 命名规范 1.1.1. [强制] 命名不能以下划线或美元符号开始和结尾 反例: name / __name / $Object / name / name$ / Object$ 1.1.2. [强制] 命名严禁使用拼音与英文混合的方式 反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3; 正例: ct / ct108 / uc / tcy / youku / hangzhou 等国际通用的名称,可视为英…

作业要求 这个作业属于哪个课程 软件工程1916-W(福州大学) 这个作业要求在哪里 项目Alpha冲刺 团队名称 基于云的胜利冲锋队 项目名称 云评:高校学生成绩综合评估及可视化分析平台 这个作业的目标 团队的代码规范.本次冲刺任务与计划 其他参考文献 1.邹欣.构建之法[M].3版:人民邮电出版社,2014. 团队阵容 队员学号 队员姓名 个人博客地址 备注 221500201 孙文慈 https://www.cnblogs.com/swc221500201/ 131601207 陈序展 h…

一.编程规约 (一) 命名规约 1. [强制]所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name / $Object / name_ / name$ / Object$ 凡是以两个或一个下划线开始,后面紧跟着一个大写字母的标识符,不管它出现在哪里,都是保留给编译程序或标准库函数使用的. 此外,凡是以一个下划线开始,后面不管跟着什么内容的标识符,如果它出现在文件范围内(即它不是出现在一个函数内),那么它也是被保留的. 如果你用一个保留…

参考资料:https://github.com/sunyardTime/React-Native-CodeStyle 感谢情书哥无私奉献 ##一.编程规约 ###(一) 命名规约 [强制] 代码中命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束: `_name / $Object / name_ / name$ / Object$` [强制] 代码中命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式: 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义.注意,即使纯…

一.前言 由于工作需要,最近重新开始拾掇shell脚本.虽然绝大部分命令自己平时也经常使用,但是在写成脚本的时候总觉得写的很难看.而且当我在看其他人写的脚本的时候,总觉得难以阅读.毕竟shell脚本这个东西不算是正经的编程语言,他更像是一个工具,用来杂糅不同的程序供我们调用.因此很多人在写的时候也是想到哪里写到哪里,基本上都像是一段超长的main函数,不忍直视.同时,由于历史原因,shell有很多不同的版本,而且也有很多有相同功能的命令需要我们进行取舍,以至于代码的规范很难统一. 考虑到上面的这…