diff options
Diffstat (limited to 'zh-cn/devices/architecture/hidl/code-style.html')
-rw-r--r-- | zh-cn/devices/architecture/hidl/code-style.html | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/zh-cn/devices/architecture/hidl/code-style.html b/zh-cn/devices/architecture/hidl/code-style.html index b16f7425..8629da72 100644 --- a/zh-cn/devices/architecture/hidl/code-style.html +++ b/zh-cn/devices/architecture/hidl/code-style.html @@ -133,7 +133,7 @@ package android.hardware.foo@1.0; <li><code><var>ROOT-DIRECTORY</var></code> 为: <ul> <li><code>hardware/interfaces</code>(如果是核心 HIDL 软件包)。</li> - <li><code>vendor/<var>VENDOR</var>/interfaces</code>(如果是供应商软件包),其中 <code><var>VENDOR</var></code> 指 SoC 供应商或原始设备制造商 (OEM)/原始设计制造商 (ODM)。</li> + <li><code>vendor/<var>VENDOR</var>/interfaces</code>(如果是供应商软件包),其中 <code><var>VENDOR</var></code> 指 SoC 供应商或 OEM/原始设计制造商 (ODM)。</li> </ul> </li> <li><code><var>MODULE</var></code> 应该是一个描述子系统的小写字词(例如 <code>nfc</code>)。如果需要多个字词,请使用嵌套式 <code><var>SUBMODULE</var></code>。可以嵌套多层。</li> @@ -177,7 +177,7 @@ package android.hardware.foo@1.0; <li><code>android.hardware</code>(如果是核心 HIDL 软件包)(映射到 <code>hardware/interfaces</code>)。</li> <li><code>vendor.<var>VENDOR</var>.hardware</code>(如果是供应商软件包),其中 <code><var>VENDOR</var></code> 指 SoC 供应商或原始设备制造商 (OEM)/原始设计制造商 (ODM)(映射到 <code>vendor/<var>VENDOR</var>/interfaces</code>)。</li> </ul> -</li><li><code><var>MODULE</var>[.<var>SUBMODULE</var>[.<var>SUBMODULE</var>[…]]]@<var>VERSION</var></code> 与<a href="#dir-structure">目录结构</a>中所述的结构内文件夹名称完全相同。</li> +</li><li><code><var>MODULE</var>[.<var>SUBMODULE</var>[.<var>SUBMODULE</var>[…]]]@<var>VERSION</var></code> 与<a href="#dir-structure">目录结构</a>中所述结构内的文件夹名称完全相同。</li> <li>软件包名称应为小写。如果软件包名称包含多个字词,则这些字词应用作子模块或以 <code>snake_case</code> 形式书写。 </li> <li>不允许使用空格。</li> @@ -319,13 +319,19 @@ android.hardware.foo@1.0::IFoo.IFooInternal.FooEnum:ENUM_OK <li>TODO</li> </ul> </li> -<li><code>/** */</code> 主要用于针对生成的文档使用的函数文档/“文档字符串”。例如: -<pre class="prettyprint"> +<li>针对生成的文档使用 <code>/** */</code>。此样式只能应用于类型、方法、字段和枚举值声明。例如:<pre class="prettyprint"> /** Replied status */ -enum FooStatus { - OK = 0, // no error - ERR_TRANSPORT = 1, // transport level error - ERR_ARG = 2 // invalid args +enum TeleportStatus { + /** Object entirely teleported. */ + OK = 0, + /** Methods return this if teleportation is not completed. */ + ERROR_TELEPORT = 1, + /** + * Teleportation could not be completed due to an object + * obstructing the path. + */ + ERROR_OBJECT = 2, + ... } </pre> </li><li>多行备注的第一行应为 <code>/**</code>,每行的开头应使用 <code>*</code>,并且应将 <code>*/</code> 单独放在最后一行(各行的星号应对齐)。例如: @@ -409,7 +415,7 @@ foo(T arg1, T arg2) generates (S ret1, S ret2); <li><strong>空格</strong>:各行不得包含尾随空格;空行不得包含空格。</li> <li><strong>空格与制表符</strong>:仅使用空格。</li> <li><strong>缩进大小</strong>:数据块缩进 <strong>4</strong> 个空格,换行缩进 <strong>8</strong> 个空格。</li> -<li><strong>大括号</strong>:(<a href="#annotations">注解值</a>除外)<strong>左</strong>大括号与前面的代码在同一行,<strong>右</strong>大括号与后面的分号占一整行。例如: +<li><strong>大括号</strong>:(<a href="#annotations">注释值</a>除外)<strong>左</strong>大括号与前面的代码在同一行,<strong>右</strong>大括号与后面的分号占一整行。例如: <pre class="prettyprint"> interface INfc { close(); |