Skip to content

Commit 86fdcc4

Browse files
authored
add table of content & introduction
1 parent f539623 commit 86fdcc4

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README_chinese_ver.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,26 @@
33
44
这篇文章基于PEP8,覆盖语法、模块布局、范式和架构等多个方面,介绍了一些个人认为比较好的python编写风格。
55

6+
原文介绍:
7+
This document goes beyond PEP8 to cover the core of what I think of as great Python style. It is opinionated, but not too opinionated. It goes beyond mere issues of syntax and module layout, and into areas of paradigm, organization, and architecture. I hope it can be a kind of condensed ["Strunk & White"][strunk-white] for Python code.
8+
9+
[strunk-white]: https://en.wikipedia.org/wiki/The_Elements_of_Style
10+
11+
# 目录
12+
13+
* [Python写作指南](#the-elements-of-python-style)
14+
* [遵从大部分PEP8规范](#follow-most-pep8-guidelines)
15+
* [关于每行代码的最大长度](#flexibility-on-line-length)
16+
* [命名的一致性](#consistent-naming)
17+
* [不值得钻牛角尖的一些点](#nitpicks-that-arent-worth-it)
18+
* [写好docstring](#writing-good-docstrings)
19+
* [范式 & 设计模式](#paradigms-and-patterns)
20+
* [“python之禅”在你代码中的具体应用](#a-little-zen-for-your-code-style)
21+
* [一些无关好坏的主观比较](#six-of-one-half-a-dozen-of-the-other)
22+
* [有用的库与项目结构](#standard-tools-and-project-structure)
23+
* [Some Inspiration](#some-inspiration)
24+
* [Contributors](#contributors)
25+
626
## 遵从大部分PEP8规范
727

828
PEP8涵盖了大部分用户最常用的使用内容,例如空格、函数/类/方法之间的换行符、模块的导入、针对不再被推荐的功能的警告等等,且将他们管理地非常好。

0 commit comments

Comments
 (0)