mirror of
https://github.com/zh-google-styleguide/zh-google-styleguide.git
synced 2024-10-22 20:10:08 +08:00
Update: add javadoc, fix some ref error
This commit is contained in:
parent
cc999a4092
commit
5c80da5487
@ -62,7 +62,7 @@
|
||||
4.1.3. 空代码块:应简洁表示
|
||||
""""""""""""""""""""""""""""""""""""""""""""""""""
|
||||
|
||||
一个空的代码块或类似块的结构可以按照K & R风格(如第 :ref:`4.1.2 <nonempty-blocks>节` 所描述)。或者,你也可以在打开后立即关闭它,中间没有字符也不需要换行(即 ``{}`` ), **除非** 它是多块语句的一部分(直接包含多个块的语句,例如 ``if`` / ``else`` 或 ``try`` / ``catch`` / ``finally`` )。
|
||||
一个空的代码块或类似块的结构可以按照K & R风格(如第4.1.2节 :ref:`非空块:K & R风格 <nonempty-blocks>` 所描述)。或者,你也可以在打开后立即关闭它,中间没有字符也不需要换行(即 ``{}`` ), **除非** 它是多块语句的一部分(直接包含多个块的语句,例如 ``if`` / ``else`` 或 ``try`` / ``catch`` / ``finally`` )。
|
||||
|
||||
例如:
|
||||
|
||||
@ -194,7 +194,7 @@ Java代码的列限制为100个字符。这里的“字符”指的是任何Unic
|
||||
|
||||
- **例外:** 枚举常量之间的空白行在 :ref:`第4.8.1节 <enum-classes>` 中有描述。
|
||||
|
||||
- 2. 此文档的其他部分所要求的(例如第3节, :ref:`源文件结构 <source-file-structure>` ,和第3.3节, :ref:`导入语句 <import-statemnts>` )。
|
||||
- 2. 此文档的其他部分所要求的(例如第3节, :ref:`源文件结构 <source-file-structure>` ,和第3.3节 :ref:`导入语句 <import-statements>` )。
|
||||
|
||||
单个空白行也可以出现在任何使用它可以提高代码可读性的位置,例如在语句之间以将代码组织成逻辑子部分。类的第一个成员或初始化器之前,或者最后一个成员或初始化器之后的空白行既不被鼓励也不被反对。
|
||||
|
||||
|
@ -73,7 +73,7 @@ Javadoc块的基本格式如下例所示:
|
||||
.. _non-required-javadoc:
|
||||
|
||||
7.3.4. 非必需的Javadoc(译者注:原文中并没有7.3.3节)
|
||||
""""""""""""""""""""""""""""""""""""""""""""""""""
|
||||
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
|
||||
|
||||
其他类和成员可根据需要或作者意愿添加Javadoc。
|
||||
|
||||
|
@ -664,7 +664,7 @@ True/False的求值
|
||||
|
||||
避免装饰器自身对外界的依赖(即不要依赖于文件, 套接字, 数据库连接等), 因为执行装饰器时(即导入模块时. ``pydoc`` 和其他工具也会导入你的模块) 可能无法连接到这些环境. 只要装饰器的调用参数正确, 装饰器应该 (尽最大努力) 保证运行成功.
|
||||
|
||||
装饰器是一种特殊形式的"顶级代码". 参见关于 :ref:`Main <main>` 的章节.
|
||||
装饰器是一种特殊形式的"顶级代码". 参见关于《Python风格规范》中“主程序”的章节.
|
||||
|
||||
不得使用 ``staticmethod``, 除非为了兼容老代码库的 API 不得已而为之. 应该把静态方法改写为模块级函数.
|
||||
|
||||
|
@ -1,16 +1,17 @@
|
||||
Manually generate PDF documents
|
||||
# Manually generate PDF documents
|
||||
-------
|
||||
|
||||
# Debian 9
|
||||
OS: Debian 9.x (or deepin 20.x)
|
||||
|
||||
## Install dependencies
|
||||
```shell
|
||||
sudo apt install texlive-lang-chinese texlive-lang-cjk texlive-xetex \
|
||||
latexmk texlive-latex-extra texlive-latex-recommended python-pip \
|
||||
texlive-latex-base texlive-plain-extra texlive-fonts-recommended \
|
||||
texlive-generic-recommended
|
||||
latexmk texlive-latex-extra texlive-latex-recommended python-pip \
|
||||
texlive-latex-base texlive-plain-extra texlive-fonts-recommended \
|
||||
texlive-generic-recommended
|
||||
```
|
||||
|
||||
# Python pip
|
||||
## Python dependencies
|
||||
|
||||
```shell
|
||||
sudo pip install Sphinx commonmark sphinx-rtd-theme
|
||||
@ -19,7 +20,7 @@ sudo pip install Sphinx commonmark sphinx-rtd-theme
|
||||
if download is too slow, try use local mirror
|
||||
|
||||
```shell
|
||||
sudo pip Sphinx commonmark sphinx-rtd-theme -i https://mirrors.aliyun.com/pypi/simple/
|
||||
sudo pip install Sphinx commonmark sphinx-rtd-theme -i https://mirrors.aliyun.com/pypi/simple/
|
||||
```
|
||||
|
||||
# Generate PDF
|
||||
@ -37,4 +38,3 @@ use follow url relace REPLACE-MISSING-FILE-NAME to you want find and install mis
|
||||
|
||||
https://packages.debian.org/search?searchon=contents&keywords=RELACE-MISSING-FILE-NAME&mode=path&suite=oldstable&arch=any
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user