From c5f514946bd8129c8c4757267e1a0a912955aa73 Mon Sep 17 00:00:00 2001 From: DrSmoothl <1787882683@qq.com> Date: Tue, 7 Apr 2026 15:19:10 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=9B=B4=E6=96=B0=E4=BB=A3=E7=A0=81?= =?UTF-8?q?=E8=A7=84=E8=8C=83=EF=BC=8C=E6=B7=BB=E5=8A=A0=E5=AF=BC=E5=85=A5?= =?UTF-8?q?=E9=A1=BA=E5=BA=8F=E7=9A=84=E8=AF=A6=E7=BB=86=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 7efc8f88..fc486081 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,4 +1,18 @@ # 代码规范 +# import 规范 +在从外部库进行导入时候,请遵循以下顺序: +1. 对于标准库和第三方库的导入,请按照如下顺序: + - 需要使用`from ... import ...`语法的导入放在前面。 + - 直接使用`import ...`语法的导入放在后面。 + - 对于使用`from ... import ...`导入的多个项,请**在保证不会引起import错误的前提下**,按照**字母顺序**排列。 + - 对于使用`import ...`导入的多个项,请**在保证不会引起import错误的前提下**,按照**字母顺序**排列。 +2. 对于本地模块的导入,请按照如下顺序: + - 对于同一个文件夹下的模块导入,使用相对导入,排列顺序按照**不发生import错误的前提下**,随便排列。 + - 对于不同文件夹下的模块导入,使用绝对导入。这些导入应该以`from src`开头,并且按照**不发生import错误的前提下**,尽量使得第二层的文件夹名称相同的导入放在一起;第二层文件夹名称排列随机。 +3. 标准库和第三方库的导入应该放在本地模块导入的前面。 +4. 各个导入块之间应该使用一个空行进行分隔。 +5. 对于现有的代码,如果导入顺序不符合上述规范,在重构代码时应该调整导入顺序以符合规范。 + ## 注释规范 1. 尽量保持良好的注释 2. 如果原来的代码中有注释,则重构的时候,除非这部分代码被删除,否则相同功能的代码应该保留注释(可以对注释进行修改以保持准确性,但不应该删除注释)。