内联文档

WordPress当前的内联文档工作真正开始于3.7发行周期,并随着hook文档计划的进展而获得动力。内联文档或“内联文档”计划是一个混合项目,向核心核心 核心是运行WordPress所需的一组软件。核心开发团队构建WordPress。、文档和开发人员中心团队。

什么是内联文档?

内联文档以内联注释、文档块等形式在WordPress本身的源代码中提供必要和有用的信息。

内联文档在每个版本中都会被解析,并且该文档会显示在开发人员的代码参考中。wordpress.org网站WordPress.org网站 用户创建和共享WordPress代码的社区网站。这是你可以下载WordPress核心、插件和主题的源代码的地方,也是社区对话和组织的中心位置。网址:https://wordpress.org/.

顶部

如何参与

内联文档被认为是“技术”文档,因此需要对WordPress代码库有一定的了解——你必须理解代码才能编写它。

1.熟悉PHP文档标准,以及格式准则记录提示.

2.使用以下命令设置WordPress代码库开发者版本的本地副本不同的流浪者(VVV)。WordPress正在使用进行版本控制SVN公司SVN公司 Apache Subversion(通常缩写为SVN,在其命令名SVN之后)是一个软件版本控制和修订控制系统。软件开发人员使用Subversion维护文件的当前和历史版本,例如源代码、网页和文档。它的目标是成为广泛使用的并发版本系统(CVS)的最兼容的继承者。WordPress核心和WordPress.org发布的代码都通过SVN进行集中管理。https://subversion.apache.org/。,但您也可以使用吉特吉特 Git是一个免费且开源的分布式版本控制系统,旨在快速高效地处理从小型到非常大型的项目。Git很容易学习,并且具有闪电般快速的性能。大多数现代插件和主题开发都是使用这个版本控制系统完成的。https://git-scm.com/.(如何做到这一点的VVV链接)。

3.阅读打开票据学习如何创建Trac公司Trac公司 Trac是贡献者为bug或功能请求创建问题的地方,与GitHub非常相似。https://core.trac.wordpress.org/.门票。

4.创建补丁:

  • 在编辑文件和创建补丁之前,请始终更新WordPress主干的本地副本。使用svn向上吉特拉力,视情况而定。
  • 从WordPress SVN或Git签出的根目录生成修补程序。例如,svn diff目录/文件名.php>函数名.diff.

5.如何提交补丁

有一个补丁可以报告内联文档故障和
例如,#48303是WordPress 5.4的修补程序。

  • 添加注释并附加修补程序文件。

6.你也可以为内联文档相关的Trac票据需要迭代。

  • 如果车票上有标记需要修补程序需要-刷新,现有的补丁可能只需要修补或根据最新的主干进行刷新。每一点点都有帮助!

顶部

接触点

如有任何问题,请点击#文档#核心文档中的通道松弛(Slack).

顶部

资源

  • PHP文档标准
  • 亚当·布朗的钩子数据库(用于提示@自的版本挂钩挂钩 在WordPress主题和开发中,钩子是可以应用于WordPres中的动作或过滤器的函数。动作是WordPress中发生特定事件时执行的功能。过滤器允许您修改某些功能。用于挂钩筛选器和操作的参数看起来相同。)

顶部

如何打开新的单据票据

基本上,只有一张罚单可以报告内联文档的失败和改进。但是,如果出于某种原因需要创建新票据,请执行以下步骤:

  1. 阅读打开票据了解如何创建Trac票证。
  2. 创建一个新机票文件的Core Trac上:
    • 建议标题格式可以是“PHPDoccorrectionforpath/to/file.php”或“Improvedocumentationforpath.to/file.php”。
    • 这个类型应该是缺陷(bug).
    • 将票据分配给组件文件与关联。
    • 离开版本空白。
    • 添加文档 焦点通过单击它。
  3. 将补丁上传到您创建的Trac票证,并添加关键字has-patch接口.
  4. 请务必留下评论来描述您新加载的补丁。简单地上传补丁不会触发任何关注该问题的人的通知。

注意:文档更改不应与代码更改混为一谈(即使是空白),除非票据明确要求两者兼而有之。

上次更新时间: