博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
团队编程项目作业2-爬虫豆瓣top250项目代码设计规范
阅读量:6263 次
发布时间:2019-06-22

本文共 835 字,大约阅读时间需要 2 分钟。

来自队长http://www.cnblogs.com/z-xx/p/7592127.html

一、程序风格:

  1.严格采用阶梯层次祖师程序代码

  各层次锁紧的分割采用VC的缺省风格 , 即没层次锁紧为4格、括号位于下一行。要求相匹配的大括号在同一列 ,对继行则要求在缩进4格。

  2.对变量的定义、尽量位于函数的开始位置。

二、命名规则:

  1.变量名的命名规则

    1)、变量命名规则要求用“匈牙利法则”。即抬头字母用变量的类型,其余部分用变量的英文意思或者其英文意思的缩进,尽量避免用中文的拼音,要求单词的第一个字母应大写

  对非通用的变量,在定义时加入注释说明,比那辆定义尽量可能放在函数的开始处。

    2)、对常量命名,要求常量名大写,常量名用英文表达其意思。

    3)、函数命名规范

      函数的命名应该尽量用英文表达出函数完成的功能。遵循动宾结构的命名法则,函数名中动词 在前,并在命名前加入函数的前缀,函数名的长度不得少于8个字母。

    4)、文件名的命名规范

    文件名的命名要求表达出文件的内容,要求文件名的长度不得少于5个字母

三、注释规范:

  1.、函数头的注释

   对于函数,应该从“功能”、“参数”、“返回值”、“主要思路”、“调用方法”、“日期”留个方面注释

  2、变量的注释:

  对于变量的注释紧跟在变量的后面说明变量的作用。原则上对于每个变量应该注释。但对于意义非常明显的变量。

  3、文件的注释:

  文件应该在文件开头加入以下注释:

  //工程:文件所在的项目名。

  //说明文件的功能

  //对文件修改内容 日期 原因 

  //说明文件的版本,完成日期

  4.、其他注释

  在各个模块功能的每一主要部分之前添加块注释,注释每一组的语句,再循环。流程的各个分支等,尽可能的多家注释

转载于:https://www.cnblogs.com/Zlxz/p/7792535.html

你可能感兴趣的文章
json \u unicode字符串转化 c++
查看>>
WinDbg 调试工具的使用
查看>>
最全linux命令
查看>>
Jexus部署.Net Core项目
查看>>
tomcat设置
查看>>
第十二单元 不同系统之间的文件传输
查看>>
安装mysql报错,错误提示:Incorrect definition of table mysql.proc
查看>>
网吧维护工具
查看>>
BOOT.INI文件参数
查看>>
Exchange-批量创建通讯组邮箱
查看>>
系统目录结构、ls命令、文件类型、alias命令
查看>>
win10 uwp 异步转同步
查看>>
简单CDN之智能DNS
查看>>
UPS工作模式简析
查看>>
词向量-LRWE模型
查看>>
Selenium打包成exe运行出错
查看>>
shell脚本之重定向、标准输入、输出、错误输出的使用
查看>>
如何从Google官网下载Chrome离线安装包
查看>>
JAR——CircleImageView
查看>>
Centos6.5下rsync文件同步安装及配置当中遇到的问题及解决方法
查看>>