让 Python 代码更易维护的七种武器 2018/09/29 · 基础知识 · 武器 原文出处: Jeff Triplett   译文出处:linux中国-Hank Chow    检查你的代码的质量,通过这些外部库使其更易维护.   可读性很重要.— Python 之禅The Zen of Python,Tim Peters 随着软件项目进入“维护模式”,对可读性和编码标准的要求很容易落空(甚至从一开始就没有建立过那些标准).然而,在代码库中保持一致的代码风格和测试标准能够显著减轻维护的压力

EditorConfig 最常见的用途是:统一文件的编码字符集以及缩进风格 使用 Eslint 做代码 lint,那么为什么还要使用 .editorconfig 呢?细细想了下,应该有两个方面吧. Eslint 确实包含 .editorconfig 中的一些属性,如缩进等,但并不全部包含,如 .editorconfig 中的 insert_final_newline 属性 Eslint 就没有.Eslint 更偏向于对语法的提示,如定义了一个变量但是没有使用时应该给予提醒.而 .editorco

1 代码风格 稍微关注一下下面这些代码标准风格指导规则将会对你大有益处,我们高度建议你通读词章,即便你此时可能正想跳过它. 1.1 让你的代码保持可读性的重要性 代码在读方面的重要性胜过写.一个代码块几分钟编写,花几个小时调试,然后有可能再也不会有人去碰它.然而当你去阅读那些昨天或者甚至10年以前编写的代码,清晰一致的代码风格就变得非常有用.清晰移动的代码能够让你不用去费劲去理解代码的不一致性,从而节省了自己的脑力,并且使代码易于维护,提高了各种规模项目的整体质量. 下面这些方法让你"多走一公里

1 原则 在开始讨论Python社区所采用的具体标准或是由其他人推荐的建议之前,考虑一些总体原则非常重要. 请记住可读性标准的目标是提升可读性.这些规则存在的目的就是为了帮助人读写代码,而不是相反. 本小节讨论你所需记住的一些原则. 1.1 假定你的代码需要维护 人们很容易倾向相信某时所完成的工作在未来不需要添加一部分或对其维护.这是由于很难预料到未来的需求,以及低估自己造成Bug的倾向.然而,所写代码很少不被修改一直存在. 如果你假设自己所写代码会"一劳永逸"的无需之后进行阅读.调试

前言 其实在新学一门知识时,我们应该注意下怎么书写代码更加规范,从开始就注意养成一个良好的习惯无论是对于bug的查找还是走人后别人熟悉代码都是非常好的,利人利己的事情何乐而不为呢,关于AngularJS中的代码风格分为几节来阐述.希望对打算学习AngularJS的新手或者已经在路上的老手有那么一丢丢的帮助也是可以的. 普遍规则 tips 01(定义一个组件脚本文件时,建议此文件的代码少于400行) (1)有利于单元测试和模拟测试. (2)增加可读性.可维护性.避免和团队在源代码控制上的冲突. (

转载自http://www.douban.com/note/134971609/ Python 的代码风格由 PEP 8 描述.这个文档描述了 Python 编程风格的方方面面.在遵守这个文档的条件下,不同程序员编写的 Python 代码可以保持最大程度的相似风格.这样就易于阅读,易于在程序员之间交流.1. 命名风格 总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格. 尽量以免单独使用小写字母'l',大写字母'O',以及大写字母'I'等容易混淆的字母. 模块命名尽量短小,使用全

from:http://blog.csdn.net/jiang_dlut/article/details/8163731 中文版维护者: 张乐 Zhang Le <r0bertz@gentoo.org> 中文版翻译者: 张乐 Zhang Le <r0bertz@gentoo.org> 中文版校译者: 王聪 Wang Cong <xiyou.wangcong@gmail.com>                wheelz <kernel.zeng@gmail.co

[PSR规范专题(3)]PSR-2 代码风格规范 标签(空格分隔): PHP 转载自:https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md 代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展. 本规范希望通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 当多名程序员在多个项目中合作时,就需要一个共同的编码规范, 而本文中的风格规范源自

转载自http://www.douban.com/note/134971609/ Python 的代码风格由 PEP 8 描述.这个文档描述了 Python 编程风格的方方面面.在遵守这个文档的条件下,不同程序员编写的 Python 代码可以保持最大程度的相似风格.这样就易于阅读,易于在程序员之间交流. 1. 命名风格 总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格. 尽量以免单独使用小写字母'l',大写字母'O',以及大写字母'I'等容易混淆的字母. 模块命名尽量短小,使用

Xcode相关概念: 概念:project 指一个项目,该项目会负责管理软件产品的全部源代码文件.全部资源文件.相关配置,一个Project可以包含多个Target. 概念:target 一个target指的是根据project中的其它内容生成的最终产品,它是线程可以直接读懂的代码. 概念:scheme scheme是对过程的定义,它定义了一个target被生成的一系列过程.可在Scheme中定义的Target的构建过程有:Build/Run/Test/Profile/Analyze/Archi

代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展. 本规范希望通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 当多名程序员在多个项目中合作时,就需要一个共同的编码规范, 而本文中的风格规范源自于多个不同项目代码风格的共同特性, 因此,本规范的价值在于我们都遵循这个编码风格,而不是在于它本身. 关键词 “必须”("MUST").“一定不可/一定不能”("MUST NOT").“需要”("REQU

在编写代码的过程中,代码的呈现形式是通过eclipse的Formatter配置文件所控制的.我们可以按照自己的习惯生成属于自己的代码风格配置文件,方便规范以后的代码编写形式.具体的操作步骤如下所示:(1)创建一个新的格式化Profile.点击菜单Window→Preferences选择Java→Code Style→Formatter.点击New按钮进行新建Profile.如下图:(2)接着基于内置的Eclipse格式新建一个Profile,名字为myprofile.如下图:(3)然后点击编辑进

本人系新接触MongoDB不久,属于MongoDB的菜鸟范畴.在使用MongoDB的过程中,总结了一些认识,在此总结跟大家分享.欢迎拍砖. 关于MongoDB的内容,在此就不做介绍了,网上有浩如烟海的文章介绍.本人不善理论,不妥之处,望指正. 想法来由:本人之前主要使用EF的CodeFirst方式做一些开发,EF的优劣在此不做评述.但已经习惯了EF式的代码编写方式,所以做了一个小的框架,来模拟实现类似EF代码风格,以减少开发者在实际使用过程中对MongoDB的关注和维护.为其取名为MongoDB

FIG组织在制定跟PHP相关规范,简称PSR,PSR旨在通过讨论我们代码项目的共同点以找出一个协作编程的方法. 什么是psr0 强调自动加载的方式 下文描述了若要使用一个通用的自动加载器(autoloader),你所需要遵守的规范: 规范 一个完全标准的命名空间(namespace)和类(class)的结构是这样的:\\(\)* 每个命名空间(namespace)都必须有一个顶级的空间名(namespace)("组织名(Vendor Name)"). 每个命名空间(namespace)

转载自http://www.douban.com/note/134971609/ Python 的代码风格由 PEP 8 描述.这个文档描述了 Python 编程风格的方方面面.在遵守这个文档的条件下,不同程序员编写的 Python 代码可以保持最大程度的相似风格.这样就易于阅读,易于在程序员之间交流.1. 命名风格 总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格. 尽量以免单独使用小写字母'l',大写字母'O',以及大写字母'I'等容易混淆的字母. 模块命名尽量短小,使用全

PEP8 代码风格指南 这篇文章原文实际上来自于这里:https://www.python.org/dev/peps/pep-0008/ 知识点 代码排版 字符串引号 表达式和语句中的空格 注释 版本注记 命名约定 公共和内部接口 程序编写建议 实验步骤 建议在实验楼中打开 Python 解释器或者 vim 自己照着做一下,或者看看以前自己写的代码 1. 介绍 这份文档给出的代码约定适用于主要的 Python 发行版所有标准库中的 Python 代码.请参阅相似的 PEP 信息,其用于描述实现

Chinese translated version of Documentation/CodingStyle   If you have any comment or update to the content, please post to LKML directly. However, if you have problem communicating in English you can also ask the Chinese maintainer for help.  Contact

排版——标题.副标题.段落(正文文本).强调内容.粗体.斜体.强调相关的类.文本对齐 <!DOCTYPE HTML> <html> <head> <meta charset="utf-8"> <title> </title> <link rel="stylesheet" href="http://netdna.bootstrapcdn.com/bootstrap/3.1.1/cs

source: https://www.kernel.org/doc/html/latest/process/coding-style.html translated by trav, travmymail@gmail.com 这是一篇阐述Linux内核编程代码风格的文档,译者以学习为目的进行翻译. 1 缩进 Tab的宽度是八个字符,因此缩进的宽度也是八个字符.有些异教徒想让缩进变成四个字符,甚至是两个字符的宽度,这些人和那些把 PI 定义为 3 的人是一个路子的. 注意:缩进的全部意义在于清晰

当查看 matplotlib 官方文档和示例时,你会发现不同的编码风格和使用模式.这些风格是完全有效的,各有其优缺点. 几乎所有的例子都可以转换成另一种风格,以实现相同的结果.当然,需要注意的是不要把自己的代码风格搞混. 两种不同的风格,都受官方支持. 下面是使用 matplotlib 的首选方式.首选 pyplot 风格,顶部的导入脚本通常是: import matplotlib.pyplot as plt import numpy as np 风格一:直接调用绘图函数,下面是一个简单的例子: