问题标签 [code-standards]

我一直在出于多种目的在工作中应用 VBA。我注意到用户对表单（带有许多宏）所做的“点击”越多，错误率就越高。我想知道而不是需要 3 次单独单击的 3 个单独的功能 - 我应该将所有这些功能集中到一个子模块中以便于使用吗？

临床工作人员表示这对他们来说效果最好，但在代码优化和保持不同功能分开方面——这不会让事情变得非常混乱吗？由于我仍在学习 VBA 的过程中，我想我会求助于迄今为止对我帮助很大的专家社区。

对于您对此的想法以及我如何创建最佳实践 VBA 标准以遵守的任何和所有评论，我将不胜感激。

这方面的一个例子是我创建的静态复制函数和每月计算函数。为了完成每月计算，它从摘要选项卡中提取数据并将其与静态数据进行比较。然而，要首先捕获静态数据 - 用户需要单击静态数据宏。我已经将静态快照功能和月度报告功能分开了，但我想知道是否可以将这两者组合成一个功能。可读性方面没有问题（因为我有解释每个部分的评论） - 但标准方面，这会不明智吗？ 如果这个问题的性质有点宽泛，我深表歉意。

我一直在练习具有适当名称间距的 JavaScript 模块模式。所以基本上我声明了命名空间，每个命名空间都封装了某些模块。这是我到目前为止所写的。代码已正确注释。

我已经完全注释了这个代码，任何人都可以理解。它声明一个简单的命名空间，然后在其中添加一个模块。该模块当然是使用封装。

我的一位导师建议该代码具有基本的缺陷标准或其他。尽管代码运行良好，但我无法弄清楚这一点。

标准明智吗？还是我做错了？

根据phpmd 规则booleanargumentflag ，这两个 PHP 类方法违反了单一职责原则 (SRP)。

应该如何编写以避免这种情况？

如果解决方案是删除默认值“= true”，那么这将如何改进代码？

我在我的 Java 项目中使用 PMD 插件。

当我运行 PMD 时，它会将警告显示为“Document Empty Constructor”。

我的代码如下...

在上面的构造函数代码中，它显示“文档空构造函数”。

我该如何解决这个问题以及为什么会发生这种情况？

我正在使用 IntelliJ IDEA 的更新版本，并尝试导出我的代码样式设置，以便所有从事特定项目的开发人员都可以使用它们。我在https://confluence.jetbrains.com/display/IntelliJIDEA/Code+Styles和http://forum.shakacode.com/t/sharing-your-intellij-rubymine-webstorm-codestyle-among-developers阅读了教程/240，这看起来相当简单。

不幸的是，这不是我的“导出设置”窗格的样子，而且我没有一行写着“代码样式”。我的看起来像

我能找到的最接近的是我突出显示的行，其中包含 CodeStyleSettingsManager 以及一大堆其他东西。但是我尝试使用它并提取 .jar 文件，却发现里面根本没有什么东西。

有谁知道导出适用于最新版本 IntelliJ 的代码样式的方法？

编辑：我的 codeStyleSettings.xml 文件仅包含以下内容：

我需要在方法之间传递对象并添加数据，如下例所示。下面写的代码是一个好的编程习惯吗？

对于 Groovy 或 Java 类或方法，我通常会在文档注释（也称为 Javadoc 注释）中包含任何 API 级别的文档，而不是常规注释。添加有关 Groovy 脚本的此类注释的类似方法是什么？

我个人不太关心 Javadoc 工具是否会提取文档。然而，关于 Groovy 脚本用途的文档在概念上似乎类似于对类的文档注释。因此，我直观地希望它们出现在文档评论中。如果我的直觉是错误的并且 doc 标签不是注释 Groovy 脚本意图的标准方法，那么记录脚本目的的首选方法是什么？

我正在使用 Doctrine 并在 PHP 中有这一行：

我想知道是否有任何代码标准用于设置具有多个调用的行。我浏览了 Symphony 和其他一些 PSR，但找不到任何特定的东西。

我必须为老板的演示文稿编写代码。最终，技术人员和软件工程师会查看代码。他想让我完善它，让它看起来很专业（我看起来不专业吗？？）所以我必须做必须做的事情。

考虑这种写作风格：

我敢打赌这编译不会有问题，但是当涉及到变量命名、带下划线的前缀、类结构等时，会有很多冲突的资源。我做了一些研究，这让我更加困惑。我知道，归根结底，这只是一种基于意见的风格或个人观点，但我只有 SO 社区来解决这个问题，我仍然相信在某个地方有一个指南或标准：

• 建议的布局说明“私有类变量应具有下划线后缀”
• 规则中关于下划线状态的高度评价答案“永远不要用下划线开始变量”并且接受的答案状态“所有带下划线的变量都是保留的”
• 命名约定中接受的答案指出“在 C++ 中，下划线通常表示私有成员变量”
• 在前导下划线的含义中，我看到构造函数的参数有下划线
• cpp 变量命名声明“ _SUM：C++ 语言中允许第一个位置的下划线”

另一种风格是：

最新的问题/答案可能是 5 岁（这并不重要）。但我想查看有关此问题的费率和答案。何时使用_variable？何时使用variable_？何时使用variable？何时使用m_variable？即使我没有数据（如“空” protected），我是否应该始终遵循类结构？变量和类名何时以及为什么是大写或小写？专业程序员/开发人员将如何编写上述示例代码？

“添加了 C#，因为我认为这两种语言在这个问题上具有相同的标准”

我知道 PHP 是一种非常容错的语言，我想这就是为什么你可以为函数调用使用混合变量，例如：

是否有不使用此类混合变量的推荐方法？

对于我自己的项目，我尽量避免这种混合变量，只是为了减少以后的错误问题和代码的清晰度。

在 PHP 7 中，应该可以声明这个函数期望的变量类型，不是吗？这是怎么做到的？