设计文档编写规范.docx
《设计文档编写规范.docx》由会员分享,可在线阅读,更多相关《设计文档编写规范.docx(2页珍藏版)》请在得力文库 - 分享文档赚钱的网站上搜索。
1、1.变量名1 .变量名的命名要清晰、明了,有明确含义:使用完整的单词或大家基本可以理解的缩写,避免使人产生 误解。较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。缩写词原词缩写词原词addraddresslitlittle-endianbigbig-endianloclocationbinbinarymsgmessagebufbuffernumnumbermodmoduleoffoffsetcliclientparaparameterentcontentpriprivilege2 .除非必要,不要用数字或较奇怪的字符来定义变量名。3 .变
2、量名采用全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式。4 .如果是供外部模块使用的接口标识符,应在最前面再添加“ne”前缀。如:ne_模块名_函数名、ne_模块名_结构名、“ne_模块名_变量名5 .文件的命名1 .django框架下文件命名为:views_模块名.py2 .service文件命名为:service.模块名.py3. urls.py文件中连接地址根据Dem。实际涉及的功能特性命名3函数命名1 .函数命名简单明了,最多不超过四个单词,如单词太长可适当简写。2.service中函数名,以web或nsh开头加以区分,公用函数可直接写函数名。4.数据库1 .
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 设计 文档 编写 规范
限制150内