-2

几天前，我被要求在一个名为“Mist”的项目中添加一些新的 JavaScript 逻辑。

我添加了一个名为“Framework”的文件夹和一个名为“PageScripts”的文件夹。

这就是我的想法：我们项目的框架脚本（我们现在没有。）应该放在“框架”中。仅与特定页面相关的脚本应放在文件夹“PageScripts”中。

但是我的经理在命名js文件方面与我有一些分歧。

我将文件名“Mist.configs.js”添加到文件夹“Framework”一个名为“filemanage.html.js”的文件到文件夹“PageScripts”。

我创建了一个名为 Mist 的对象，其属性名为“configs”。在 Mist.configs.js 中。而 filemanage.html.js 仅包含与页面“filemanage.html”相关的脚本。

我的经理的意见：'Mist.configs.js' 应该命名为'config.js'，因为我们的项目已经被称为'Mist'。'filemanage.html.js' 应该命名为 'filemanage.js' 并且不需要在其中添加 '.html' 因为它已经在 'PageScripts' 文件夹中。

我的意见：'Mist' 应该保留，因为它是一个命名空间。它更具可读性。' '.html' 应该保留，因为它与 'filemanage.html' 相关 如果我们有一个页面名称 filemanage.php 怎么办？和其他实用文件'filemanage.js'？

你怎么看？关于命名和构建 js 文件的任何建议？

我不知道如何说服我的经理，他要求我提供一些文件来支持我的观点。

我该怎么办 ？

谢谢。

4

1 回答 1

2

首先，没有必要如此广泛地与你的经理来回重复。也就是说，这似乎归结为几个核心问题，我将在这里解决。

为快乐的开发团队做贡献

不管这之后的几点，您总是希望优先考虑保持项目的一致性和您的团队满意。如果您的团队正在使用某种方法，请保留它，除非您愿意并被允许为整个项目更改系统。其次，倾向于为您的平台制定标准实践，因为这样可以让其他开发人员更容易理解您所做的事情，从而降低成本并缩短公司的开发时间。

组织 Javascript

大多数时候，Javascript 应该放在一个（可能是嵌套的）文件夹中，并根据您的平台进行优化。也就是说，对其进行设置，以便它可以在适当的情况下使用 CDN，或者在 Rails 中使用资产管道，等等。如果 javascript 文件几乎被任意放置在不同的文件夹中，那么对于未来的开发人员来说将会非常困惑，因为几乎可以保证他们不会像您那样解释每个位置决定。

文件扩展名

决定是否命名文件filemanage.html.js应该filemanage.js取决于您是否将 HTML 放入文件中。它不应该简单地用于表明它在某种程度上与某些 HTML 文件“相关”。

于 2013-06-08T05:20:07.883 回答