在分支项目中使用@package和@since的最佳做法

时间:2019-01-10 18:44:22

标签: php git-fork docblocks

我的项目使用WordPress入门主题FoundationPress。我使用Github,并在社区改进代码时使用upstream remote从父存储库更新我的项目。作为记录,我已经花了很长时间编写程序,但几乎总是一个人编写,而且我对docblock和代码文档的经验非常缺乏。我知道在某种程度上这可能是基于观点的,因为这似乎是寻找其他答案的趋势,但我觉得我没有掌握正确的用法。

父项目在PHP文件上使用如下所示的PHP Docblock,每个文件始终仅显示一次,例如:

/**
 * Brief File Description
 *
 * @package FoundationPress
 * @since FoundationPress 1.0.0
 */

当我添加自己的新PHP文件时,我一直在添加一个类似的块,但改用我的项目名称:

/**
 * Brief File Description
 *
 * @package MyProject
 * @since MyProject 0.1.0
 */

有时候,我会使用自己的功能更新现有文件。我一直将@since放在这些函数的上方,所以就像这样:

/**
 * Brief File Description
 *
 * @package FoundationPress
 * @since FoundationPress 1.0.0
 */

function foo() { ... }

function bar() { ... }

/**
 * My Function Description 
 *
 * @since MyProject 0.1.0
*/
function my_foo() { ... }

有时候,我会更新现有功能-我只为那些功能保留文档块,但我想知道是否应该更新任何内容。

  1. 是否有最佳实践或至少被普遍接受的方式来处理这种情况(一个分叉的项目,它与父存储库保持同步),所以我的代码对其他程序员更有用?
  2. 似乎还有很多其他文档块参数和选项,例如每个功能的文档块。我应该争取建议的详细程度吗?
  3. 是否有在我的项目中也添加有关其他类型文件(SCSS,JS等)的类似文档的最佳实践?父项目似乎没有任何内容,但我想添加一些内容。

我的目标是以同事或将来的维护者将来可能会有用的格式创建代码和代码内文档。

0 个答案:

没有答案