当前位置: 代码迷 >> Web前端 >> 定名规范总结
  详细解决方案

定名规范总结

热度:171   发布时间:2012-10-26 10:30:59.0
命名规范总结

Flex 编码指南

下载:http://www.5uflash.com/Flex-AIR/Flexziliao/3042.html

?

?http://opensource.adobe.com/wiki/display/flexsdk/Coding+Conventions

?

1.http://assets.taobaocdn.com/tbra/dpl/common/assets_guide.html

Assets目录组织和文件命名规范

  1. assets 原有目录保持不变,但只做维护更新用
  2. 增加以下新目录:
  3. app 目录存放项目资源文件,用项目名称或项目代号命名,多个单词用下划线(_)分隔,全部小写
  4. sys 目录存放通用资源文件,比如全站通用图标,旺旺点灯脚本等等。此目录暂时由小马、圆心和玉伯维护,等规范统一后,再开放给大家
  5. tbra 目录存放 TBra, 目前由小马和玉伯维护。需要增加新组件时,请联系玉伯
  6. yui 目录存放 YUI, 需要引用 YUI 的组件时,推荐用 YUILoader 加载
  7. app -? xxx项目下,文件存放位置如下:

    图片比较少时,可以直接放在项目根目录下;如果超过5张,请存放在 img 目录下。其它文件直接放在根目录,如果文件非常多(超过20个),可以根据功能另行组织(比如把 js 和 css 按前台和后台来分,或者按功能模块来分)
  8. 项目目录下的文件名,不推荐含有项目代号,比如 itaobao_base.js, 直接用 base.js 即可,因为路径中已经包含项目代号,比如 app/itaobao/base.js
  9. 所有目录名和文件名,一律小写,必须是英文单词或产品名称的拼音,多个单词用下划线(_)连接。只能出现英文字母、数字和下划线
  10. 文件有版本时,用 vN 描述,小版本用 a, b, c, d 英文字母区分,比如 global_v3a.css, global_v4.css
  11. tbra 和 yui 目录下的文件名沿用 YUI 的命名规则,特殊处理,不要仿效
  12. css 和 js 文件,必须使用 GB 编码(GB2312, GBK, GB18030)
  13. 制作 css sprite 时,同一个图片里仅存放同类背景图,只有特殊频道才允许将所有背景图合为一张图片
  14. logo 和常用 icon 使用单独文件,直接 <img> 嵌入页面
  15. html 文件的 doctype, 统一采用 html4 strict:
    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
    

Copyright (c) 2008, Taobao.com Inc. All rights reserved.

  • 2008-12-24 yubo: 增加 html doctype 的约定
  • 2008-12-18 yubo: 增加文件编码规范和 CSS Sprite 规范
  • 2008-11-22 yubo: 整理此规范

?

2.http://www.17joys.com/php/cms/cms-6-83.html

17joys项目代码的命名规范

??????? 每个项目都会有相关的开发文档,其中一个非常有用的文档就是代码编写规范。
下面是使用ThinkPHP应该尽量遵循的命名规范,请大家编写时务必注意,养成良好的代码编写习惯是做好一个程序员非常关键的一步:

  • 类文件都是以.class.php为后缀(这里是指的ThinkPHP内部使用的类库文件,不代表外部加载的类库文件),使用驼峰法命名,并且首字母大写,例如DbMysql.class.php。
  • 函数、配置文件等其他类库文件之外的一般是以.php为后缀(第三方引入的不做要求)。
  • 确保文件的命名和调用大小写一致,是由于在类Unix系统上面,对大小写是敏感的(而ThinkPHP在调试模式下面,即使在Windows平台也会严格检查大小写)。
  • 类名和文件名一致(包括上面说的大小写一致),例如 UserAction类的文件命名是UserAction.class.php, InfoModel类的文件名是InfoModel.class.php,?
  • 函数的命名使用小写字母和下划线的方式,例如 get_client_ip
  • Action控制器类以Action为后缀,例如 UserAction、InfoAction
  • 模型类以Model为后缀,例如UserModel、InfoModel
  • 方法的命名使用驼峰法,并且首字母小写,例如 getUserName
  • 属性的命名使用驼峰法,并且首字母小写,例如 tableName
  • 以双下划线“__”打头的函数或方法作为魔法方法,例如 __call 和 __autoload
  • 常量以大写字母和下划线命名,例如 HAS_ONE和 MANY_TO_MANY
  • 配置参数以大写字母和下划线命名,例如HTML_CACHE_ON
  • 语言变量以大写字母和下划线命名,例如MY_LANG,以下划线打头的语言变量通常用于系统语言变量,例如 _CLASS_NOT_EXIST_。
  • 数据表和字段采用小写加下划线方式命名,例如 think_user 和 user_name

另外一点,ThinkPHP默认使用UTF-8编码,所以请确保你的程序文件采用UTF-8编码格式保存,并且去掉BOM信息头(去掉BOM头信息有很多方式,不同的编辑器都有设置方法,也可以用工具进行统一检测和处理)。

?

?

3.http://www.kuqin.com/language/20080712/11058.html

?

Google C++编程风格指南

?

  相关解决方案