README

🛑 项目不受支持

bxApiDocs

bxApiDocs旨在简化1С-Битрикс开发者（1C-Битрикс: Управление сайтом - 商业）的生活，尽管并非最甜美

这是一个包含模块的文件夹/bitrix/modules/，是1С-Битрикс: Управление сайтом的一部分，但去除了多余的文件和文件夹（不包含.php，没有类方法，常量等），添加了常量、事件和phpDocs帮助文档。

功能

本身没有功能，但它包含了一些大型特性，这些特性与IDE配合使用时可以极大地简化开发者的工作（轻松，愉快等 - 因此，请小心使用）。

特性

• API本身，包含了所有phpDocs，这些文档是从官方文档资源自动提取的。
• 甚至还有常量。但是只有那些可以在上述官方文档资源中找到的帮助文档。
• 模块事件。合成类包含一系列方法，即包含特定模块可能发生的事件的容器，所有这些都有文档。

包含使用示例和指向官方文档资源的链接的文档。常量和事件位于相应模块的bx_events.php和bx_constants.php文件中（例如/modules/main/bx_events.php和/modules/main/bx_constants.php）。相应地，在bx_constants.php文件中使用的常量，在其实际使用的地方被注释掉。

如何使用

将其添加到您喜欢的IDE的索引或Composer中，然后一切就绪。幸福！

Composer

composer require matiaspub/bx-api-docs --dev

Composer将所有文档下载到vendor文件夹，IDE将索引更改。您只需享受结果即可。

Eclipse

必须使用PDT（或其替代品）。在PHP Explorer窗口中，右键单击项目，在弹出菜单中选择配置 -> 添加PHP支持。再次右键单击项目，在菜单中选择包含路径 -> 配置包含路径。在窗口中，可以在库选项卡中添加modules文件夹（点击添加外部源文件夹按钮），或者在项目选项卡中添加modules项目（点击添加按钮）。预先需要创建一个基于modules文件夹的项目，并添加PHP支持（通过第一种方法的配置 -> 添加PHP支持）。使用第二种方法，您将能够编辑modules项目的文件，而当使用第一种方法时，modules的提示文件将是只读的。

PhpStorm

在PHP IDE PhpStorm的设置中（文件 -> 设置 -> 默认设置 -> PHP或文件 -> 设置 -> 语言和框架 -> PHP），在包含路径区域，点击"+"，添加到modules文件夹的路径。

注意：在第一种情况下，为所有新项目添加modules文件夹，在第二种情况下，为当前项目添加。

裤子变成。裤裤变成……

主要的$APPLICATION, $DB, $USER, $USER_FIELD_MANAGER单例，带有提示

关于方法和类的最全面文档

查看模块事件和了解如何使用它的方法如下

常量文档

是的，我同意

并非所有方法和都有提示，也存在错误，但即使如此，也有很多内容（再次强调，这些内容是自动从官方文档网站上解析出来的，该网站的顺序不超过API）。此外，您还有机会参与全球的善举，通过提交更改或补充到这个分支中。

更新

只有当主要模块的大版本更新时才会发生更新。

联系方式

• twitter: matiaspub
• email: [email protected]