sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextEnglish}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget/rust/coding-guidelinesmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/zh_TW/rust/coding-guidelinesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/it_IT/rust/coding-guidelinesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/ja_JP/rust/coding-guidelinesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/ko_KR/rust/coding-guidelinesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/sp_SP/rust/coding-guidelinesmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageChinese (Simplified)uh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhW/var/lib/git/docbuild/linux/Documentation/translations/zh_CN/rust/coding-guidelines.rsthKubhnote)}(hX{此文件的目的是为让中文读者更容易阅读和理解，而不是作为一个分支。 因此， 如果您对此文件有任何意见或更新，请先尝试更新原始英文文件。 如果您发现本文档与原始文件有任何不同或者有翻译问题，请发建议或者补丁给 该文件的译者，或者请求中文文档维护者和审阅者的帮助。h]h paragraph)}(hX{此文件的目的是为让中文读者更容易阅读和理解，而不是作为一个分支。 因此， 如果您对此文件有任何意见或更新，请先尝试更新原始英文文件。 如果您发现本文档与原始文件有任何不同或者有翻译问题，请发建议或者补丁给 该文件的译者，或者请求中文文档维护者和审阅者的帮助。h]hX{此文件的目的是为让中文读者更容易阅读和理解，而不是作为一个分支。 因此， 如果您对此文件有任何意见或更新，请先尝试更新原始英文文件。 如果您发现本文档与原始文件有任何不同或者有翻译问题，请发建议或者补丁给 该文件的译者，或者请求中文文档维护者和审阅者的帮助。}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hh5Documentation/translations/zh_CN/disclaimer-zh_CN.rsthKhhubah}(h]h ]h"]h$]h&]uh1hhhhhhhhNubh field_list)}(hhh](hfield)}(hhh](h field_name)}(hOriginalh]hOriginal}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhKubh field_body)}(h)Documentation/rust/coding-guidelines.rst h]h)}(h(Documentation/rust/coding-guidelines.rsth]h(Documentation/rust/coding-guidelines.rst}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhubah}(h]h ]h"]h$]h&]uh1hhhubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(h翻译h]h翻译}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhKubh)}(h-司延腾 Yanteng Si h]h)}(h,司延腾 Yanteng Si h](h司延腾 Yanteng Si <}(hj hhhNhNubh reference)}(hsiyanteng@loongson.cnh]hsiyanteng@loongson.cn}(hj*hhhNhNubah}(h]h ]h"]h$]h&]refurimailto:siyanteng@loongson.cnuh1j(hj ubh>}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1hhj ubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubeh}(h]h ]h"]h$]h&]uh1hhhhhhhhKubhsection)}(hhh](htitle)}(h 编码指南h]h 编码指南}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1j[hjXhhhhhK ubh)}(h7本文档描述了如何在内核中编写Rust代码。h]h7本文档描述了如何在内核中编写Rust代码。}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hjXhhubjW)}(hhh](j\)}(h风格和格式化h]h风格和格式化}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1j[hjyhhhhhKubh)}(hX)代码应该使用 ``rustfmt`` 进行格式化。这样一来，一个不时为内核做贡献的人就不需要再去学 习和记忆一个样式指南了。更重要的是，审阅者和维护者不需要再花时间指出风格问题，这样就可以 减少补丁落地所需的邮件往返。h](h代码应该使用 }(hjhhhNhNubhliteral)}(h ``rustfmt``h]hrustfmt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX  进行格式化。这样一来，一个不时为内核做贡献的人就不需要再去学 习和记忆一个样式指南了。更重要的是，审阅者和维护者不需要再花时间指出风格问题，这样就可以 减少补丁落地所需的邮件往返。}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjyhhubh)}(hW``rustfmt`` 不检查注释和文档的约定。因此，这些仍然需要照顾到。h]h)}(hjh](j)}(h ``rustfmt``h]hrustfmt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhL 不检查注释和文档的约定。因此，这些仍然需要照顾到。}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1hhjyhhhhhNubh)}(h使用 ``rustfmt`` 的默认设置。这意味着遵循Rust的习惯性风格。例如，缩进时使用4个空格而 不是制表符。h](h使用 }(hjhhhNhNubj)}(h ``rustfmt``h]hrustfmt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhv 的默认设置。这意味着遵循Rust的习惯性风格。例如，缩进时使用4个空格而 不是制表符。}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjyhhubh)}(h在输入、保存或提交时告知编辑器/IDE进行格式化是很方便的。然而，如果因为某些原因需要在某 个时候重新格式化整个内核Rust的源代码，可以运行以下程序::h]h在输入、保存或提交时告知编辑器/IDE进行格式化是很方便的。然而，如果因为某些原因需要在某 个时候重新格式化整个内核Rust的源代码，可以运行以下程序:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjyhhubh literal_block)}(hmake LLVM=1 rustfmth]hmake LLVM=1 rustfmt}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhKhjyhhubh)}(hv也可以检查所有的东西是否都是格式化的（否则就打印一个差异），例如对于一个CI，用::h]hu也可以检查所有的东西是否都是格式化的（否则就打印一个差异），例如对于一个CI，用:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK!hjyhhubj)}(hmake LLVM=1 rustfmtcheckh]hmake LLVM=1 rustfmtcheck}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhK#hjyhhubh)}(h像内核其他部分的 ``clang-format`` 一样， ``rustfmt`` 在单个文件上工作，并且不需要 内核配置。有时，它甚至可以与破碎的代码一起工作。h](h像内核其他部分的 }(hj+hhhNhNubj)}(h``clang-format``h]h clang-format}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubh 一样， }(hj+hhhNhNubj)}(h ``rustfmt``h]hrustfmt}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubht 在单个文件上工作，并且不需要 内核配置。有时，它甚至可以与破碎的代码一起工作。}(hj+hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK%hjyhhubeh}(h]id2ah ]h"]风格和格式化ah$]h&]uh1jVhjXhhhhhKubjW)}(hhh](j\)}(h注释h]h注释}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1j[hjehhhhhK*ubh)}(hX*“普通”注释（即以 ``//`` 开头，而不是 ``///`` 或 ``//!`` 开头的代码文档）的写法与文 档注释相同，使用Markdown语法，尽管它们不会被渲染。这提高了一致性，简化了规则，并允许在 这两种注释之间更容易地移动内容。比如说:h](h“普通”注释（即以 }(hjvhhhNhNubj)}(h``//``h]h//}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjvubh 开头，而不是 }(hjvhhhNhNubj)}(h``///``h]h///}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjvubh 或 }(hjvhhhNhNubj)}(h``//!``h]h//!}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjvubh 开头的代码文档）的写法与文 档注释相同，使用Markdown语法，尽管它们不会被渲染。这提高了一致性，简化了规则，并允许在 这两种注释之间更容易地移动内容。比如说:}(hjvhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK,hjehhubj)}(h2// `object` is ready to be handled now. f(object);h]h2// `object` is ready to be handled now. f(object);}hjsbah}(h]h ]h"]h$]h&]hhforcelanguagerusthighlight_args}uh1jhhhK0hjehhubh)}(h此外，就像文档一样，注释在句子的开头要大写，并以句号结束（即使是单句）。这包括 ``// SAFETY:``, ``// TODO:`` 和其他“标记”的注释，例如:h](hv此外，就像文档一样，注释在句子的开头要大写，并以句号结束（即使是单句）。这包括 }(hjhhhNhNubj)}(h``// SAFETY:``h]h // SAFETY:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h ``// TODO:``h]h// TODO:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh) 和其他“标记”的注释，例如:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK5hjehhubj)}(h/// FIXME: The error should be handled properly.h]h/// FIXME: The error should be handled properly.}hjsbah}(h]h ]h"]h$]h&]hhjjrustj}uh1jhhhK8hjehhubh)}(hX注释不应该被用于文档的目的：注释是为了实现细节，而不是为了用户。即使源文件的读者既是API 的实现者又是用户，这种区分也是有用的。事实上，有时同时使用注释和文档是很有用的。例如，用 于 ``TODO`` 列表或对文档本身的注释。对于后一种情况，注释可以插在中间；也就是说，离要注 释的文档行更近。对于其他情况，注释会写在文档之后，例如:h](hX 注释不应该被用于文档的目的：注释是为了实现细节，而不是为了用户。即使源文件的读者既是API 的实现者又是用户，这种区分也是有用的。事实上，有时同时使用注释和文档是很有用的。例如，用 于 }(hjhhhNhNubj)}(h``TODO``h]hTODO}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh 列表或对文档本身的注释。对于后一种情况，注释可以插在中间；也就是说，离要注 释的文档行更近。对于其他情况，注释会写在文档之后，例如:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK Foo { // ... }h]h/// Returns a new [`Foo`]. /// /// # Examples /// // TODO: Find a better example. /// ``` /// let foo = f(42); /// ``` // FIXME: Use fallible approach. pub fn f(x: i32) -> Foo { // ... }}hj/sbah}(h]h ]h"]h$]h&]hhjjrustj}uh1jhhhKAhjehhubh)}(h一种特殊的注释是 ``// SAFETY:`` 注释。这些注释必须出现在每个 ``unsafe`` 块之前，它们 解释了为什么该块内的代码是正确/健全的，即为什么它在任何情况下都不会触发未定义行为，例如:h](h一种特殊的注释是 }(hj?hhhNhNubj)}(h``// SAFETY:``h]h // SAFETY:}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubh, 注释。这些注释必须出现在每个 }(hj?hhhNhNubj)}(h ``unsafe``h]hunsafe}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubh 块之前，它们 解释了为什么该块内的代码是正确/健全的，即为什么它在任何情况下都不会触发未定义行为，例如:}(hj?hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKPhjehhubj)}(hF// SAFETY: `p` is valid by the safety requirements. unsafe { *p = 0; }h]hF// SAFETY: `p` is valid by the safety requirements. unsafe { *p = 0; }}hjqsbah}(h]h ]h"]h$]h&]hhjjrustj}uh1jhhhKShjehhubh)}(hXX``// SAFETY:`` 注释不能与代码文档中的 ``# Safety`` 部分相混淆。 ``# Safety`` 部 分指定了（函数）调用者或（特性）实现者需要遵守的契约。 ``// SAFETY:`` 注释显示了为什么一个（函数）调用者或（特性）实现者实际上尊重了 ``# Safety`` 部分或语言参考中的前提条件。h](j)}(h``// SAFETY:``h]h // SAFETY:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh# 注释不能与代码文档中的 }(hjhhhNhNubj)}(h ``# Safety``h]h# Safety}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh 部分相混淆。 }(hjhhhNhNubj)}(h ``# Safety``h]h# Safety}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhW 部 分指定了（函数）调用者或（特性）实现者需要遵守的契约。 }(hjhhhNhNubj)}(h``// SAFETY:``h]h // SAFETY:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh_ 注释显示了为什么一个（函数）调用者或（特性）实现者实际上尊重了 }(hjhhhNhNubj)}(h ``# Safety``h]h# Safety}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh+ 部分或语言参考中的前提条件。}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKXhjehhubeh}(h]id3ah ]h"]注释ah$]h&]uh1jVhjXhhhhhK*ubjW)}(hhh](j\)}(h 代码文档h]h 代码文档}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j[hjhhhhhK_ubh)}(hRust内核代码不像C内核代码那样被记录下来（即通过kernel-doc）。取而代之的是用于记录Rust 代码的常用系统：rustdoc工具，它使用Markdown（一种轻量级的标记语言）。h]hRust内核代码不像C内核代码那样被记录下来（即通过kernel-doc）。取而代之的是用于记录Rust 代码的常用系统：rustdoc工具，它使用Markdown（一种轻量级的标记语言）。}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKahjhhubh)}(h5要学习Markdown，外面有很多指南。例如：h]h5要学习Markdown，外面有很多指南。例如：}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKdhjhhubh)}(hhttps://commonmark.org/help/h]j))}(hjh]hhttps://commonmark.org/help/}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j(hjubah}(h]h ]h"]h$]h&]uh1hhhhKfhjhhubh)}(h2一个记录良好的Rust函数可能是这样的:h]h2一个记录良好的Rust函数可能是这样的:}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhjhhubj)}(hX/// Returns the contained [`Some`] value, consuming the `self` value, /// without checking that the value is not [`None`]. /// /// # Safety /// /// Calling this method on [`None`] is *[undefined behavior]*. /// /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html /// /// # Examples /// /// ``` /// let x = Some("air"); /// assert_eq!(unsafe { x.unwrap_unchecked() }, "air"); /// ``` pub unsafe fn unwrap_unchecked(self) -> T { match self { Some(val) => val, // SAFETY: The safety contract must be upheld by the caller. None => unsafe { hint::unreachable_unchecked() }, } }h]hX/// Returns the contained [`Some`] value, consuming the `self` value, /// without checking that the value is not [`None`]. /// /// # Safety /// /// Calling this method on [`None`] is *[undefined behavior]*. /// /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html /// /// # Examples /// /// ``` /// let x = Some("air"); /// assert_eq!(unsafe { x.unwrap_unchecked() }, "air"); /// ``` pub unsafe fn unwrap_unchecked(self) -> T { match self { Some(val) => val, // SAFETY: The safety contract must be upheld by the caller. None => unsafe { hint::unreachable_unchecked() }, } }}hj@sbah}(h]h ]h"]h$]h&]hhjjrustj}uh1jhhhKjhjhhubh)}(hS这个例子展示了一些 ``rustdoc`` 的特性和内核中遵循的一些惯例:h](h这个例子展示了一些 }(hjPhhhNhNubj)}(h ``rustdoc``h]hrustdoc}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjPubh, 的特性和内核中遵循的一些惯例:}(hjPhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh block_quote)}(hX~- 第一段必须是一个简单的句子，简要地描述被记录的项目的作用。进一步的解释必须放在额 外的段落中。 - 不安全的函数必须在 ``# Safety`` 部分记录其安全前提条件。 - 虽然这里没有显示，但如果一个函数可能会恐慌，那么必须在 ``# Panics`` 部分描述发 生这种情况的条件。 请注意，恐慌应该是非常少见的，只有在有充分理由的情况下才会使用。几乎在所有的情况下， 都应该使用一个可失败的方法，通常是返回一个 ``Result``。 - 如果提供使用实例对读者有帮助的话，必须写在一个叫做``# Examples``的部分。 - Rust项目（函数、类型、常量……）必须有适当的链接(``rustdoc`` 会自动创建一个 链接)。 - 任何 ``unsafe`` 的代码块都必须在前面加上一个 ``// SAFETY:`` 的注释，描述里面 的代码为什么是正确的。 虽然有时原因可能看起来微不足道，但写这些注释不仅是记录已经考虑到的问题的好方法， 最重要的是，它提供了一种知道没有额外隐含约束的方法。 h]h bullet_list)}(hhh](h list_item)}(h第一段必须是一个简单的句子，简要地描述被记录的项目的作用。进一步的解释必须放在额 外的段落中。 h]h)}(h第一段必须是一个简单的句子，简要地描述被记录的项目的作用。进一步的解释必须放在额 外的段落中。h]h第一段必须是一个简单的句子，简要地描述被记录的项目的作用。进一步的解释必须放在额 外的段落中。}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj}ubah}(h]h ]h"]h$]h&]uh1j{hjxubj|)}(hN不安全的函数必须在 ``# Safety`` 部分记录其安全前提条件。 h]h)}(hM不安全的函数必须在 ``# Safety`` 部分记录其安全前提条件。h](h不安全的函数必须在 }(hjhhhNhNubj)}(h ``# Safety``h]h# Safety}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh% 部分记录其安全前提条件。}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j{hjxubj|)}(hXY虽然这里没有显示，但如果一个函数可能会恐慌，那么必须在 ``# Panics`` 部分描述发 生这种情况的条件。 请注意，恐慌应该是非常少见的，只有在有充分理由的情况下才会使用。几乎在所有的情况下， 都应该使用一个可失败的方法，通常是返回一个 ``Result``。 h](h)}(h虽然这里没有显示，但如果一个函数可能会恐慌，那么必须在 ``# Panics`` 部分描述发 生这种情况的条件。h](hR虽然这里没有显示，但如果一个函数可能会恐慌，那么必须在 }(hjhhhNhNubj)}(h ``# Panics``h]h# Panics}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, 部分描述发 生这种情况的条件。}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h请注意，恐慌应该是非常少见的，只有在有充分理由的情况下才会使用。几乎在所有的情况下， 都应该使用一个可失败的方法，通常是返回一个 ``Result``。h](h请注意，恐慌应该是非常少见的，只有在有充分理由的情况下才会使用。几乎在所有的情况下， 都应该使用一个可失败的方法，通常是返回一个 }(hjhhhNhNubj)}(h ``Result``h]hResult}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh。}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1j{hjxubj|)}(hf如果提供使用实例对读者有帮助的话，必须写在一个叫做``# Examples``的部分。 h]h)}(he如果提供使用实例对读者有帮助的话，必须写在一个叫做``# Examples``的部分。h]he如果提供使用实例对读者有帮助的话，必须写在一个叫做``# Examples``的部分。}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j{hjxubj|)}(htRust项目（函数、类型、常量……）必须有适当的链接(``rustdoc`` 会自动创建一个 链接)。 h]h)}(hsRust项目（函数、类型、常量……）必须有适当的链接(``rustdoc`` 会自动创建一个 链接)。h](hGRust项目（函数、类型、常量……）必须有适当的链接(}(hj%hhhNhNubj)}(h ``rustdoc``h]hrustdoc}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%ubh! 会自动创建一个 链接)。}(hj%hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj!ubah}(h]h ]h"]h$]h&]uh1j{hjxubj|)}(hXP任何 ``unsafe`` 的代码块都必须在前面加上一个 ``// SAFETY:`` 的注释，描述里面 的代码为什么是正确的。 虽然有时原因可能看起来微不足道，但写这些注释不仅是记录已经考虑到的问题的好方法， 最重要的是，它提供了一种知道没有额外隐含约束的方法。 h](h)}(h任何 ``unsafe`` 的代码块都必须在前面加上一个 ``// SAFETY:`` 的注释，描述里面 的代码为什么是正确的。h](h任何 }(hjOhhhNhNubj)}(h ``unsafe``h]hunsafe}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubh, 的代码块都必须在前面加上一个 }(hjOhhhNhNubj)}(h``// SAFETY:``h]h // SAFETY:}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubh; 的注释，描述里面 的代码为什么是正确的。}(hjOhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjKubh)}(h虽然有时原因可能看起来微不足道，但写这些注释不仅是记录已经考虑到的问题的好方法， 最重要的是，它提供了一种知道没有额外隐含约束的方法。h]h虽然有时原因可能看起来微不足道，但写这些注释不仅是记录已经考虑到的问题的好方法， 最重要的是，它提供了一种知道没有额外隐含约束的方法。}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjKubeh}(h]h ]h"]h$]h&]uh1j{hjxubeh}(h]h ]h"]h$]h&]bullet-uh1jvhhhKhjrubah}(h]h ]h"]h$]h&]uh1jphhhKhjhhubh)}(hl要了解更多关于如何编写Rust和拓展功能的文档，请看看 ``rustdoc`` 这本书，网址是:h](hJ要了解更多关于如何编写Rust和拓展功能的文档，请看看 }(hjhhhNhNubj)}(h ``rustdoc``h]hrustdoc}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh 这本书，网址是:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubjq)}(hBhttps://doc.rust-lang.org/rustdoc/how-to-write-documentation.html h]h)}(hAhttps://doc.rust-lang.org/rustdoc/how-to-write-documentation.htmlh]j))}(hjh]hAhttps://doc.rust-lang.org/rustdoc/how-to-write-documentation.html}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j(hjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jphhhKhjhhubh)}(hr此外，内核支持通过在链接目标前添加 ``srctree/`` 来创建相对于源代码树的链接。例如:h](h4此外，内核支持通过在链接目标前添加 }(hjhhhNhNubj)}(h ``srctree/``h]hsrctree/}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh2 来创建相对于源代码树的链接。例如:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hH//! C header: [`include/linux/printk.h`](srctree/include/linux/printk.h)h]hH//! C header: [`include/linux/printk.h`](srctree/include/linux/printk.h)}hjsbah}(h]h ]h"]h$]h&]hhjjrustj}uh1jhhhKhjhhubh)}(h或者:h]h或者:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(h3/// [`struct mutex`]: srctree/include/linux/mutex.hh]h3/// [`struct mutex`]: srctree/include/linux/mutex.h}hj#sbah}(h]h ]h"]h$]h&]hhjjrustj}uh1jhhhKhjhhubeh}(h]id4ah ]h"] 代码文档ah$]h&]uh1jVhjXhhhhhK_ubjW)}(hhh](j\)}(h命名h]h命名}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j[hj;hhhhhKubh)}(h0Rust内核代码遵循通常的Rust命名空间:h]h0Rust内核代码遵循通常的Rust命名空间:}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj;hhubjq)}(h7https://rust-lang.github.io/api-guidelines/naming.html h]h)}(h6https://rust-lang.github.io/api-guidelines/naming.htmlh]j))}(hj`h]h6https://rust-lang.github.io/api-guidelines/naming.html}(hjbhhhNhNubah}(h]h ]h"]h$]h&]refurij`uh1j(hj^ubah}(h]h ]h"]h$]h&]uh1hhhhKhjZubah}(h]h ]h"]h$]h&]uh1jphhhKhj;hhubh)}(hX,当现有的C语言概念（如宏、函数、对象......）被包装成Rust抽象时，应该使用尽可能接近C语 言的名称，以避免混淆，并在C语言和Rust语言之间来回切换时提高可读性。例如，C语言中的 ``pr_info`` 这样的宏在Rust中的命名是一样的。h](h当现有的C语言概念（如宏、函数、对象......）被包装成Rust抽象时，应该使用尽可能接近C语 言的名称，以避免混淆，并在C语言和Rust语言之间来回切换时提高可读性。例如，C语言中的 }(hj|hhhNhNubj)}(h ``pr_info``h]hpr_info}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj|ubh/ 这样的宏在Rust中的命名是一样的。}(hj|hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj;hhubh)}(h说到这里，应该调整大小写以遵循Rust的命名惯例，模块和类型引入的命名间隔不应该在项目名称 中重复。例如，在包装常量时，如:h]h说到这里，应该调整大小写以遵循Rust的命名惯例，模块和类型引入的命名间隔不应该在项目名称 中重复。例如，在包装常量时，如:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj;hhubj)}(hC#define GPIO_LINE_DIRECTION_IN 0 #define GPIO_LINE_DIRECTION_OUT 1h]hC#define GPIO_LINE_DIRECTION_IN 0 #define GPIO_LINE_DIRECTION_OUT 1}hjsbah}(h]h ]h"]h$]h&]hhjjcj}uh1jhhhKhj;hhubh)}(h>在Rust中的等价物可能是这样的（忽略文档）。:h]h>在Rust中的等价物可能是这样的（忽略文档）。:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj;hhubj)}(hpub mod gpio { pub enum LineDirection { In = bindings::GPIO_LINE_DIRECTION_IN as _, Out = bindings::GPIO_LINE_DIRECTION_OUT as _, } }h]hpub mod gpio { pub enum LineDirection { In = bindings::GPIO_LINE_DIRECTION_IN as _, Out = bindings::GPIO_LINE_DIRECTION_OUT as _, } }}hjsbah}(h]h ]h"]h$]h&]hhjjrustj}uh1jhhhKhj;hhubh)}(h也就是说， ``GPIO_LINE_DIRECTION_IN`` 的等价物将被称为 ``gpio::LineDirection::In`` 。 特别是，它不应该被命名为 ``gpio::gpio_line_direction::GPIO_LINE_DIRECTION_IN`` 。h](h也就是说， }(hjhhhNhNubj)}(h``GPIO_LINE_DIRECTION_IN``h]hGPIO_LINE_DIRECTION_IN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh 的等价物将被称为 }(hjhhhNhNubj)}(h``gpio::LineDirection::In``h]hgpio::LineDirection::In}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh* 。 特别是，它不应该被命名为 }(hjhhhNhNubj)}(h5``gpio::gpio_line_direction::GPIO_LINE_DIRECTION_IN``h]h1gpio::gpio_line_direction::GPIO_LINE_DIRECTION_IN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh 。}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj;hhubeh}(h]id5ah ]h"]命名ah$]h&]uh1jVhjXhhhhhKubeh}(h]id1ah ]h"] 编码指南ah$]h&]uh1jVhhhhhhhK ubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(j[N generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjOerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(j)j&jbj_jjj8j5j!ju nametypes}(j)jbjj8j!uh}(j&jXj_jyjjej5jjj;u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}j]KsRparse_messages]transform_messages] transformerN include_log];Documentation/translations/zh_CN/rust/coding-guidelines.rst(NNNNta decorationNhhub.