文档规范

文档规范

    • 一致性的建议
    • 代码布局
      • 缩进
      • 行的最大长度
      • 空行
      • 编码
      • import顺序
    • 空格
      • 以下不推荐使用空格
      • 其他建议
    • 注释
      • 注释块
  • 题目

##规范文档

为了方便维护、他人阅读使用,整理出改编码规范文档。请大家开发是遵循本规范进行更开发。 ?本文档参考自Guido的《Python》一文,并从《Barry’s styie guide》中添加了部分内容,?Guido以及我的个人建议

一致性的建议

开发项目劲量保持一致性,不然会出现不和谐。

代码布局

缩进

python是使用缩进来进行代码布局。

用tab键还是空格

只能用其中一个,不可以混用。

行的最大长度

72个字节以内,多了也不会报错,但是推荐不超过。可以用反斜杠来续行

空行

用两行分割顶部函数和类的定义

用一行分割成员方法的定义

在一个函数内使用空行时请注意谨慎适用一个逻辑段

编码

在python2.4中内核已经开始支持Unicode了,无论什么情况,UTF-8才是王道!

coding:utf-8

import顺序

1.python标准库的import

2.第三方库的import

3.自定义的库import

并且每组import之间使用一行空行分割

空格

以下不推荐使用空格

1.紧挨着小括号,中括号,大括号

2.逗号,分号,冒号前面。

3.紧贴着函数调用的参数列表前

4.紧贴在索引或切片下标开始的开式括号前

5.在赋值或其他运算符周围的用于和其他并排的一个以上的空格

其他建议

在二元运算符两边加空格,按你的看法在算数运算符周围插入空格,始终保持两边的空格相等!

不要在用于指定关键字参数或默认参数值的‘=’号周围使用空格

def complex(real,inam=0.0):
    return magic(r=real,i=imag)

不要将多行语句写在同一行上

注释

注释必须跟代码保持一致,更改代码时优先修改注释

注释必须是完整的

注释必须是一个句子或短语

注释短请省略句号

注释由一个或多个句子构成的段落,每个句子以句号结尾

注释请用英文

注释块

注释块通常应用于跟随着一-些(或者全部)代码并和这些代码有着相同的缩进层次。

注释块中每行以"#"和一个空格开始(除非他是注释内的缩进文本)。

注释块内的段落以仅含单个"#"的行分割。

注释块上下方最好有一空行包围(或上方两行下方一行,对一个新函数定义段的注释)。

题目

  • 第一题:microbit和Arduino的区别
    microbit:1、在线编程工具+本地编程工具,2、尺寸 43mm * 52mm,3、兼容电压:3V,4、带有模拟窗口,即使手上没有硬件也能玩起来
    Arduino: 1、本地编程工具(Arduino IDE),2、尺寸 53mm * 69mm,3、兼容电压:3V-5V,4、必须要有硬件才能玩

  • 第二题
    1.microbit是一款由英国广播电视公司(BBC)推出的专为青少年编程教育设计,并由微软,三星ARM,英国兰卡斯特大学等合作伙伴共同完成开发的微型电脑。
    2.microbit仅有信用卡的一半大小。5*5可编程LED点阵灯、两颗可编程按键、加速计、电子罗盘、温度计、蓝牙等电子模块。

  • 第三题
    文档规范_第1张图片

  • 第四题:实时监测温度的python代码
    while True:
    t=temperature()
    display.show(str(t)+’#’,delay=1000)

  • 第五题:microbit支持哪些软件编程,并说出他们的优点和缺点
    mu:
    优点:在没网的时候也能编程,
    缺点:不能用中文注释,寻找错误的时候要重新上传一次代码,上传代码时不可以进行任何操作
    makecode在线编程:
    优点:当没有microbit板的时候也能看效果
    缺点:在没网的时候用不了,因为服务器在国外,会有点卡顿
    makecode离线编程:
    优点:在没网的时候也能编程
    缺点:功能没有在线的齐全,不能及时得到更新
    手机编程:
    优点:在没有电脑的时候可以
    缺点:比起电脑来说操作比较复杂

  • 第六题:makecode国内服务器安装步骤
    1、安装Node.js
    2、在安装node.js的地址,同一及地址创建一个microbit文件夹
    3、运行Node.js command prompt打开命令行窗口(最好以管理员方式运行),输入npm install -g pxt
    4、继续在命令行窗口中输入:pxt target microbit。过程有点久
    5、安装完成之后打开cmd,输入microbit的路径,切换到microbit文件夹的地址后输入pxt serve
    国内服务器就安装完毕!

你可能感兴趣的:(Python)