Skip to content

Commit 598edfa

Browse files
committed
"add some lines"
1 parent 0e1f82f commit 598edfa

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/v2/dev/index_cn.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
开发标准
22
========
3+
PaddlePaddle遵守如下三个部分的开发标准。
4+
- 代码风格
5+
Paddle中包含了C++, Python, Shell等多种编程语言。C++的开发标准遵守Google C++ Style, 并加入了一些定制规则,https://github.com/PaddlePaddle/cpp-primer-digest。Python的开发标准遵守PEP-8标准, Shell遵守Google Shell Style。以上风格在提交代码时候, 代码库会通过pre-commit, clang-format自动化工具做风格检查。不满足风格要求的代码会编译失败。pre-commit也会自动format, 协助修改代码格式。
6+
7+
- 文档格式
8+
Paddle面向国内外用户,包含了中文和英文两部分的文档。设计文档和issue问题描述都推荐使用英文。对于设计文档,重在问题描述,背景阐述,然后才是解决方案。API文档由Sphinx生成,因此代码注释需要符合Sphinx文档标准。同样的,Paddle的集成测试工具会检测文档格式。推荐本地使用docker编译生成文档,本地修复文档。
9+
10+
- 框架定制
11+
Paddle V2使用新增Layer方式定义新的操作。定制Layer前请参阅已有的Layer, 如有通用性, 欢迎提交Layer实现。如何定制一个新的Layer见如下表。
312

413
.. toctree::
514
:maxdepth: 1

0 commit comments

Comments
 (0)