DIY AI 第 4 部分:设置文件系统以实现无缝编码

如果您一直按照我们的指南进行操作,那么您现在已经使用 Python 设置了 Visual Studio Code 以及一个项目文件,其中存储了虚拟环境。当您处理项目时,您还希望在虚拟环境中工作。如果这些对您来说听起来很陌生,那么返回并从头开始可能是个好主意。对于我们其他人来说,这应该是我们开始进行一些实际编码之前的最后一部分。这次,我们将设置文件系统,这非常简单,但却是整个项目的支柱,帮助我们保持一切井井有条且可访问,无论它有多大。

如前所述,精心设计的文件夹结构将帮助您将所有内容井然有序,从而轻松找到您需要的内容。它还可以让您的项目不断发展,而不会变得混乱或混乱。

组织好的文件还将促进团队合作并符合行业标准,确保您的项目易于维护或与其他系统集成。

以下是我们建议添加到项目文件中的文件夹列表,以及您应该已经拥有的虚拟环境文件夹。要创建文件夹,请右键单击一侧并选择“新建文件夹”。虽然这些文件夹现在是空的,但随着您开发项目,它们会很快填满。

源代码/

src/ 文件夹将保存项目的所有源文件。这些脚本将执行项目的主要任务,例如文件处理、搜索或分析数据。

测试/

测试文件夹将保存您创建的用于测试 src/ 文件夹中的脚本的任何脚本。此文件夹中的文件将有助于确保您的项目正常运行并且没有故障和错误。将此文件夹视为调试器。

数据/

数据文件夹是您存储程序所需的任何数据的位置。例如,如果您有一个脚本需要检查电子表格中的信息。您将将该电子表格保留在数据文件中。您还将存储脚本的输出,以便稍后比较或查看它们。

日志/

日志文件夹将包含程序生成的所有日志,主要是调试代码所必需的错误日志。

文档/

文档文件将保存与您的程序相关的文档,包括用户指南或技术参考。

要求.txt

requirements.txt 文件不是文件夹,但最好将其包含在目录设置中,以便使其保持最新。此文件列出了您正在使用的所有 Python 库,这可以使其他团队成员更轻松地在其计算机上设置相同的环境。如果您喜欢在多台计算机上编码,它也会很有帮助。

自述文件.md

.md 文件是使用 Markdown 语言格式化文本的 Markdown 文档文件。我们可以使用它创建一个文件,向人们介绍您的程序并提供如何使用它的说明。写下来看看它随着时间的推移如何变化可能很有趣,或者你可以暂时不写它。

无论您是单独工作还是与团队协作,此文件夹结构都是任何 Python 项目的坚实基础。我们将在这个项目中使用它。

关注 GeekSided,了解从头开始创建人工智能的最新信息。

发表评论

您的电子邮件地址不会被公开, 必填字段已标记 *