对我的新插件进行同行评审？

Question

获得经验丰富的WordPress开发人员来看我的插件并提出建设性批评的最佳方法是什么？我已经编写了代码来解决此网站上的一些问题，我认为它们也对其他人也有用。但是，由于它们将通过我的第一个公共WordPress插件，而且我在公共WordPress目录中看到了许多不太好的示例，因此我想知道“我站立的位置”，以及如何改善插件。我读过了 最佳实践清单, ，并且仍然需要应用其中一些，但是我也想回答更普遍的问题：“这是解决这个问题的好方法吗？”

我只是重新阅读 相关讨论 wp-hackers （我没有意识到参与者也参与了这个网站，而“最佳实践”问题是该站点的直接结果）。我不确定我的需求是否会被这样的系统涵盖，我同意 保罗的担忧:

当我上周阅读有关此主题的原始评论时，我的目的是整理一个同行审核过程，插件开发人员可以为其他插件开发人员提供建议，以作为其代码的审查。我最初将此建议视为“嗯，您的代码有效，但是您编写的一组例程，如果您只是挂在此WP过滤器中并尝试了此技术，那就更好了（请参见XXX插件） ”。我认为的目标是共享WP插件开发知识，并使任何平庸的插件开发人员成为更好的开发人员。像我一样。

这将是与进行逐点清单审查的范围不同的范围，这将是“指导”。似乎有很多人愿意这样做，并且（甚至更好的是）其中许多人在这里参加此网站，那么我们如何将所有能量转变为具体的东西呢？

我当前的示例是我写给的三个插件 解决我的“图像调整大小”问题. 。我对每个插件写了长时间的介绍性评论，这（我希望）使得在不阅读完整代码的情况下更容易理解我的意图。我还能做些什么，使其他人更容易看待它？ 请忽略我当前的具体请求。他们不仅对他们来说还为时过早，而且我改变了主意，不想用我的具体情况破坏一般的讨论。

Answer 1

最简单的方法是两步的方法：

1. 将您的插件发布给公众。 直播后，除了开发人员之外，您还将开始从最终用户那里获得反馈。如果需要，请将其作为“ beta”版本发布，并在readme文件中大量强调它。
2. 问。 到处都有资深的WordPress开发人员：这里，WP-Hackers列表上， WordPress作业, ，跟踪 @wordpress 在Twitter上等。这只是将您的插件扔出去并寻求反馈的问题。

通常，按照与开发人员查看的核心补丁相同的步骤：

• 写下来
• 记录它
• 联系开发人员（通过上述渠道之一，或直接直接与开发人员联系），并寻求反馈

至于将本网站上发生的“指导”转变为更具体的东西，这将是一个有机过程。如您已经提到的，创建一种插入式审核过程的努力 前 实际审查任何东西似乎已经停滞了。使任何东西脱离地面的唯一方法是 实际上 开始这样做。因此，不要仅仅谈论寻找老将开发人员并获得反馈，出去，找到一个，获取反馈并写下过程的发展方式。

然后，可以使用未来的插件和未来的开发人员重复。但是你必须从某个地方开始...

Answer 2

快速查看 https://gist.github.com/675437 我看到了一些小点，主要是关于可读性的：

• 编写好的代码文档：DocBlocks…和Inline评论，只要有什么绝对清楚的事情。
• 将宽松的功能分为较短的单独函数。它们更容易阅读和解决审稿人的评论。
• 对齐您的分配操作员，在括号之间添加空格。
• 请给我80个字符的线长度！食物仍然不能包裹长线。 :(
• 保持代码»左«，保存凹痕。代替：

.  

public function checkUrl()
{
    if (is_404()) {
        // code
    }
}

… 写 …

public function checkUrl()
{
    if ( ! is_404() ) {
        return;
    }
    // code
}

---

我今晚写了一个新插件……我想知道我是否可以准确地问您的问题。好时机。 :)

Answer 3

它只是让我想到了AppScan： http://www01.ibm.com/software/rational/products/appscan/source/ ; http://www-01.ibm.com/software/rational/products/appscan/source/features/ 轻版本的试用： http://www-01.ibm.com/software/awdtools/appscan/express/

这可以做PHP，并且可以在其中放置额外的规则以检查事物。这样一来，可以自动化零件（就像Toscho的答案中的一些最佳实践一样），它可以检查安全性，编码标准，优化等...

我只是说：如果工具可以检查80％，那么有关宗师的手册检查的20％检查将会更少。这也将有助于生成合规性报告，以在一家大型公司内使用插件，该公司要求附加代码围绕其他代码。

我们为其他人自动化事物，所以为什么不为自己呢？