代码风格

今天给大家分享Python 风格规范，以下代码中 Yes 表示推荐，No 表示不推荐。 分号 不要在行尾加分号, 也不要用分号将两条命令放在同一行。 行长度 每行不超过80个字符 以下情况除外： 长的导入模块语句 注释里的URL 不要使用反斜杠连接行。 Python 会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号。 推荐: foo_bar(self, width, height, color='black', design=None, x='foo', emphasis=None, highlight=0) if (width == 0 and height == 0 and color == 'red' and emphasis == 'strong'): 如果一个文本字符串在一行放不下, 可以使用圆括号来实现隐式行连接: x = ('这是一个非常长非常长非常长非常长 ' '非常长非常长非常长非常长非常长非常长的字符串') 在注释中，如果必要，将长的URL放在一行上。 Yes: # See details at # http://www.example.com/us/developer/documentation/api/content/v2.0/csv_file_name_extension

一：文件结构 1）. 单一规则：坚持每个文件只定义一样东西（例如服务或组件），考虑把文件大小限制在 400 行代码以内。 单组件文件非常容易阅读、维护，并能防止在版本控制系统里与团队冲突； 单组件文件可以防止一些隐蔽的程序缺陷，当把多个组件合写在同一个文件中时，可能造成共享变量、创建意外的闭包，或者与依赖之间产生意外耦合等情况； 单独的组件通常是该文件默认的导出，可以用路由器实现按需加载； 最关键的是，可以让代码更加可复用、更容易阅读，减少出错的可能性； 2）. 坚持定义简单函数，最好限制在 75 行之内。 简单函数更易于测试，特别是当它们只做一件事，只为一个目的服务时； 简单函数促进代码重用； 简单函数更易于阅读； 简单函数更易于维护； 小函数可避免易在大函数中产生的隐蔽性错误，例如与外界共享变量、创建意外的闭包或与依赖之间产生意外耦合等。 二：命名 1）总体命名原则： 所有符号使用一致的命名规则，遵循同一个模式来描述符号的特性和类型，推荐的模式为 feature.type.ts 。 命名约定提供了一致的方式来查找内容，让你一眼就能找到。 项目的一致性是至关重要的。团队内的一致性也很重要。整个公司的一致性会提供惊人的效率； 命名约定帮助你更快得找到想找的代码，也更容易理解它； 目录名和文件名应该清楚的传递它们的意图。 例如， app/heroes/hero-list

官网： www.fhadmin.org 此项目为Springboot工作流版本 windows 风格,浏览器访问操作使用，非桌面应用程序。 1.代码生成器： [正反双向](单表、主表、明细表、树形表，快速开发利器) freemaker模版技术 ,0个代码不用写,生成完整的一个模块,带页面、建表sql脚本、处理类、service等完整模块 2.多数据源：（支持同时连接无数个数据库，可以不同的模块连接不同数的据库）支持N个数据源 3.阿里数据库连接池druid,安全权限框架 shiro（菜单权限和按钮权限）, 缓存框架 ehcache 4.代码编辑器，在线模版编辑，仿开发工具编辑器 5.调用摄像头拍照 自定义裁剪编辑头像，头像图片色度调节 6.websocket及时站内信并声音提醒、实时在线管理、websocket及时刷新页面（完胜ajax技术） 工作流模块 1. 模型管理 ：web在线流程设计器、预览流程xml、导出xml、部署流程 2. 流程管理 ：导入导出流程资源文件、查看流程图、根据流程实例反射出流程模型、激活挂起 3. 运行中流程 ：查看流程信息、当前任务节点、当前流程图、作废暂停流程、指派待办人 4. 历史的流程 ：查看流程信息、流程用时、流程状态、查看任务发起人信息 5. 待办任务 ：查看本人个人任务以及本角色下的任务、办理、驳回、作废、指派一下代理人 6. 已办任务

原文地址： https://github.com/uber-go/guide/blob/master/style.md 译文出处： https://github.com/uber-go/guide 本文永久链接： https://github.com/gocn/translator/blob/master/2019/w38_uber_go_style_guide.md 译者： 咔叽咔叽 校对者： fivezh ， cvley 目录 介绍 指南 接口的指针 接收者和接口 零值 Mutexes 是有效的 复制 Slice 和 Map Defer 的使用 channel 的大小是 1 或者 None 枚举值从 1 开始 Error 类型 Error 包装 处理类型断言失败 避免 Panic 使用 go.uber.org/atomic 性能 strconv 优于 fmt 避免 string 到 byte 的转换 代码样式 聚合相似的声明 包的分组导入的顺序 包命名 函数命名 别名导入 函数分组和顺序 减少嵌套 不必要的 else 顶层变量的声明 在不可导出的全局变量前面加上 _ 结构体的嵌入 使用字段名去初始化结构体 局部变量声明 nil 是一个有效的 slice 减少变量的作用域 避免裸参数 使用原生字符串格式来避免转义 初始化结构体 在 Printf 之外格式化字符串 Printf

工程实践项目还在前期调研阶段，目前还没正式开展代码阶段，由于做的是 JAVA 相关的，我总结了一些关于 JAVA 代码规范的经验。 一般原则 l 尽量使用完整的英文描述符 l 采用适用于相关领域的术语 l 采用大小写混合增强可读性 l 尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一 l 避免使用长的名字 l 避免使用类似的名字，或者仅仅是大小写不同的名字 l 避免使用下划线（除静态常量等） 命名的字母大小写问题 l 包名： 字母全小写 例如 : cn.coderstory.Activity.Main l 类，接口 ：首字母大写，其他全小写 例如 : class Container l 方法，变量 ：第二个单词开始首字母大写 例如 : seedMessage l 常量： 大写，单词用 “_” 分割 例如 : final static MIN_WIDTH = 4 l 接口 ：首字母大写 ，后缀 Impl 例如 : class ContainerImpl l 异常类： 首字母大写， 后缀 Exception 例如 : DataNotFoundException l 抽象类 ：首字母大写， 前缀 Abstract 例如 : AbstractBeanDefinition l Test 类： 首字母大写， 后缀 Test 例如 : public Location

　　我的工程实践是机器学习相关，因此我在GitHub上选了下面的源代码进行学习： https://github.com/WillKoehrsen/machine-learning-project-walkthrough 一、对源代码的分析 　　1、目录结构 　　该源代码使用Python语言，在jupyter notebook上编写。在文件目录下有a uto_ml、 data、deprecated、images四个文件夹和Machine Learning Project Part 1.ipynb、Machine Learning Project Part 2.ipynb、Machine Learning Project Part 3.ipynb等源代码文件，其中： 　　文件夹auto_ml中存放的是管道程序； 　　文件夹data中存放的是该项目的训练集和测试集等数据压缩包； 　　文件夹deprecated中存放的是对数据进行探索的程序文件； 　　文件夹images中存放的是该项目用到的图像文件。 　　 　　2、代码风格 　　由于该项目没有使用类，所有暂不讨论类的相关问题。我们随机选取了源代码中的一段个函数实现代码。 　　 代码中实现不同功能的部分用空行隔开，并且在前面都有对本段功能描述的注释语句，清晰易懂； 函数的命名和变量的命名都采用英文半拼＋英文全拼且用下划线隔开的组合方式

思考：作为一个开发者（特别是一个日常进行开发的一线开发者），应该定期或者不定期阅读一些优秀的开源代码， 从一些优秀的开源软件中（比如c语言中的redis和libevent，比如java语言的elasticearch,netty，lucene ，比如c++语言的leveldb，tensorflow 等等）中汲取营养； 这些营养包括： 编码风格； 数据结构（非日常编码工作中常见的，能够拓宽视野，增长见识的）和在其上的相关操作； 它的功能介绍和实现方式； 。。。。。 来源： https://www.cnblogs.com/big1987/p/11544160.html

《JavaScript语言精粹》相比《JavaScript权威指南》而言，是一本太薄的书了。然而也许正因为小而精，所以难有权威指南那样阅读起来浅显易懂却又醍醐灌顶般的感觉，语言精粹还是略微感觉有些艰涩难懂。不过，就像作者说的那样，这是一本需要反复阅读和回味的书。 下面总结一些精粹中的精粹吧。 （一）代码风格 保持良好代码风格的重要性对任何编程语言都是一样的。这里是作者总结的js的一些不错的编程风格。 （1）空格的使用： 代码块内容和对象字面量缩进4个空格。 把一个空格放在 if 和 ( 之间，使之看上去不同于函数调用。 除了 . 和 [ 之外的所有中置运算符的两边都放了空格。 （2）语句的分行： 每行最多放一个语句。 一个语句一行放不下的话，则在一个冒号或二元运算符后拆开它，折断后的语句其余部分多缩进4个空格。 （3）代码块的使用： 在诸如 if 和 while 这样结构化的语句里，我始终使用代码块。 使用K&R风格，把 { 放在一行的结尾而不是下一行的开头。 （4）注释的使用： 保持注释始终是最新的。 js代码中多采用行注释，块注释多用于正式的文档记录和注释。 程序结构本身能进行自我说明。 （5）js天生的设计问题： js有些特性本身的设计便不太合理，稍不注意就会出错。因此使用时要尽量避免由此而产生的问题。 避免那些看起来像有错误（但在js中实际正确）的习惯用法。

item detail PEP 8 Title Style Guide for Python Code Version c451868df657 Last-Modified 2016-06-08 10:43:53 -0400 (Wed, 08 Jun 2016) Author Guido van Rossum <guido at python.org> , Barry Warsaw <barry at python.org> , Nick Coghlan <ncoghlan at gmail.com> Status Active Type Process Content-Type text/x-rst Created 05-Jul-2001 Post-History 05-Jul-2001, 01-Aug-2013 Introduction 介绍 A Foolish Consistency is the Hobgoblin of Little Minds 尽信书则不如无书 Code lay-out 代码布局 Indentation 缩进 Tabs or Spaces 制表符还是空格 Maximum Line Length 行的最大长度 Should a line break before or after a binary operator 在二元运算符之前应该换行吗 Blank

Python 代码风格 和 PEP8 Python 的代码风格由 PEP 8 描述。这个文档描述了 Python 编程风格的方方面面。在遵守这个文档的条件下，不同程序员编写的 Python 代码可以保持最大程度的相似风格。这样就易于阅读，易于在程序员之间交流。 1 变量 常量 : 大写加下划线 USER_CONSTANT 对于不会发生改变的全局变量，使用大写加下划线。 私有变量 : 小写和一个前导下划线 _private_value Python 中不存在私有变量一说，若是遇到需要保护的变量，使用小写和一个前导下划线。但这只是程序员之间的一个约定，用于警告说明这是一个私有变量，外部类不要去访问它。但实际上，外部类还是可以访问到这个变量。 内置变量 : 小写，两个前导下划线和两个后置下划线 __class__ 两个前导下划线会导致变量在解释期间被更名。这是为了避免内置变量和其他变量产生冲突。用户定义的变量要严格避免这种风格。以免导致混乱。 2 函数和方法 总体而言应该使用，小写和下划线。但有些比较老的库使用的是混合大小写，即首单词小写，之后每个单词第一个字母大写，其余小写。但现在，小写和下划线已成为规范。 私有方法 ： 小写和一个前导下划线 def _secrete(self): print "don't test me." 这里和私有变量一样，并不是真正的私有访问权限