jjzjj

javascript - 为每个模块组件重复模块名称

coder 2024-05-09 原文

著名的Best Practice Recommendations for Angular App Structure博客文章概述了新推荐的 angularjs 项目结构,它现在是面向组件的,而不是面向功能的,或者如 initial github issue 中所命名的那样。 - “按功能组织”。

博文建议每个模块中的每个文件都应以模块名称开头,例如:

userlogin/
    userlogin.js
    userlogin.css                
    userlogin.html                
    userlogin-directive.js
    userlogin-directive_test.js
    userlogin-service.js
    userlogin-service_test.js 

问题是:与按功能命名文件相比,在模块中的每个文件名中重复模块名称的意义、优缺点是什么?例如:

userlogin/
    userlogin.js
    userlogin.css                
    userlogin.html   
    controllers.js             
    directives.js
    services.js

我问的原因是我来自 Django世界上有一个有点相似的想法 projects and apps .每个应用通常都有自己的 models.pyviews.pyurls.pytests.py。脚本名称中没有重复的应用程序名称。

我希望我没有越过基于意见的界限,并且有遵循该方法的正当理由。

最佳答案

这是有充分理由的,它是为了改进任何重要代码库的一个非常重要的方面(尤其是当涉及大型开发团队时),即我们所说的“可查看性”。

“概览能力”是指代码库的组织(文件夹结构、文件命名、元对象等)提供已实现软件的快速且信息丰富的概览的能力。

由于以下原因(非详尽列表),“可概览性”的重要性随着代码库和项目开发团队的规模呈指数级增长*:

  1. 当代码库很大时,代码的某些部分在特定时间段内保持不变的可能性会增加(随着此“冷”期的持续时间增加)。

  2. 当新成员加入团队时,您希望他们尽快跟上进度(而不是让他们在此过程中感到沮丧)。 “Overviewability”有助于提供对整个项目的良好的高级抽象,并且通常还可以很好地了解事情是如何工作的(通常它会产生一种熟悉的感觉;就好像你以前看过代码库一样——尽管你还没有)。


“那么,好吧,“可查看性”很重要。这就是为什么我们有这种以组件为中心的良好结构等。但是为什么在每个文件前加上组件名称前缀?”

嗯,这听起来可能很有趣,但是为所有与组件相关的文件名添加前缀可以确保特定的顺序。例如。 HTML 部分或 CSS 将始终出现在 Controller 等之前:

...               
userlogin.html                
userlogin-controller.js
...

如果没有前缀,您最终会根据组件的名称得到不同的顺序。例如:

...                       ...                      ...
controller.js             controller.js            bookself.html
...                       ...                      ...
service.js         VS     service.js        VS     controller.js
...                       ...                      ...
userlogin.html            zombi.html               service.js
...                       ...                      ...

使用前缀确保文件以特定顺序出现: Controller 总是在 HTML 部分之后,服务也在后面等等。例如:

...                             ...                         ...
userlogin.html                  zombi.html                  bookself.html
...                             ...                         ...
userlogin-controller.js    VS   zombi-controller.js    VS   bookself-controller.js
...                             ...                         ...
userlogin-service.js            zombi-service.js            bookself-service.js
...                             ...                         ...

这可能看起来微不足道,但事实并非如此;尤其是当一个人习惯了它。
请注意,人脑非常擅长识别视觉模式(例如文件浏览器中文件夹和文件结构的树节点表示所创建的模式)。

即 Controller 不在名为“-controllers.js”的文件中。
它驻留在第一个文件中,该文件的名称明显比前面的文件长
服务(如果有的话)驻留在末尾名称较小的文件中,等等。

搞砸了(即因为首字母弄乱了顺序,或者因为长/短组件名称弄乱了它们的相对长度)你自己的情况类似于必须从硬盘读取一些东西,而不是只是从 RAM 中读取它。 (没有开发人员想去那里:))


<子> *:实际上,这里重要的是我们所说的“开发团队通量”,即团队成员离开(例如从事其他工作、离开公司等)或引入新成员的频率。
通常,团队越大,通量越大。

关于javascript - 为每个模块组件重复模块名称,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/25005897/

有关javascript - 为每个模块组件重复模块名称的更多相关文章

  1. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  2. ruby-on-rails - Ruby net/ldap 模块中的内存泄漏 - 2

    作为我的Rails应用程序的一部分,我编写了一个小导入程序,它从我们的LDAP系统中吸取数据并将其塞入一个用户表中。不幸的是,与LDAP相关的代码在遍历我们的32K用户时泄漏了大量内存,我一直无法弄清楚如何解决这个问题。这个问题似乎在某种程度上与LDAP库有关,因为当我删除对LDAP内容的调用时,内存使用情况会很好地稳定下来。此外,不断增加的对象是Net::BER::BerIdentifiedString和Net::BER::BerIdentifiedArray,它们都是LDAP库的一部分。当我运行导入时,内存使用量最终达到超过1GB的峰值。如果问题存在,我需要找到一些方法来更正我的代

  3. ruby-on-rails - 在混合/模块中覆盖模型的属性访问器 - 2

    我有一个包含模块的模型。我想在模块中覆盖模型的访问器方法。例如:classBlah这显然行不通。有什么想法可以实现吗? 最佳答案 您的代码看起来是正确的。我们正在毫无困难地使用这个确切的模式。如果我没记错的话,Rails使用#method_missing作为属性setter,因此您的模块将优先,阻止ActiveRecord的setter。如果您正在使用ActiveSupport::Concern(参见thisblogpost),那么您的实例方法需要进入一个特殊的模块:classBlah

  4. ruby - 当使用::指定模块时,为什么 Ruby 不在更高范围内查找类? - 2

    我刚刚被困在这个问题上一段时间了。以这个基地为例:moduleTopclassTestendmoduleFooendend稍后,我可以通过这样做在Foo中定义扩展Test的类:moduleTopmoduleFooclassSomeTest但是,如果我尝试通过使用::指定模块来最小化缩进:moduleTop::FooclassFailure这失败了:NameError:uninitializedconstantTop::Foo::Test这是一个错误,还是仅仅是Ruby解析变量名的方式的逻辑结果? 最佳答案 Isthisabug,or

  5. ruby - 获取模块中定义的所有常量的值 - 2

    我想获取模块中定义的所有常量的值:moduleLettersA='apple'.freezeB='boy'.freezeendconstants给了我常量的名字:Letters.constants(false)#=>[:A,:B]如何获取它们的值的数组,即["apple","boy"]? 最佳答案 为了做到这一点,请使用mapLetters.constants(false).map&Letters.method(:const_get)这将返回["a","b"]第二种方式:Letters.constants(false).map{|c

  6. ruby - 模块嵌套代码风格偏好 - 2

    我的假设是moduleAmoduleBendend和moduleA::Bend是一样的。我能够从thisblog找到解决方案,thisSOthread和andthisSOthread.为什么以及什么时候应该更喜欢紧凑语法A::B而不是另一个,因为它显然有一个缺点?我有一种直觉,它可能与性能有关,因为在更多命名空间中查找常量需要更多计算。但是我无法通过对普通类进行基准测试来验证这一点。 最佳答案 这两种写作方法经常被混淆。首先要说的是,据我所知,没有可衡量的性能差异。(在下面的书面示例中不断查找)最明显的区别,可能也是最著名的,是你的

  7. ruby-on-rails - 使用 config.threadsafe 时从 lib/加载模块/类的正确方法是什么!选项? - 2

    我一直致力于让我们的Rails2.3.8应用程序在JRuby下正确运行。一切正常,直到我启用config.threadsafe!以实现JRuby提供的并发性。这导致lib/中的模块和类不再自动加载。使用config.threadsafe!启用:$rubyscript/runner-eproduction'pSim::Sim200Provisioner'/Users/amchale/.rvm/gems/jruby-1.5.1@web-services/gems/activesupport-2.3.8/lib/active_support/dependencies.rb:105:in`co

  8. ruby - 在 Ruby 中按名称传递函数 - 2

    如何在Ruby中按名称传递函数?(我使用Ruby才几个小时,所以我还在想办法。)nums=[1,2,3,4]#Thisworks,butismoreverbosethanI'dlikenums.eachdo|i|putsiend#InJS,Icouldjustdosomethinglike:#nums.forEach(console.log)#InF#,itwouldbesomethinglike:#List.iternums(printf"%A")#InRuby,IwishIcoulddosomethinglike:nums.eachputs在Ruby中能不能做到类似的简洁?我可以只

  9. ruby-on-rails - 应用程序的名称是否可以作为变量使用? - 2

    当我创建一个Rails应用程序时,控制台:railsnewfoo我的代码可以使用字符串“foo”吗?puts"Yourapp'snameis"+app_name_bar 最佳答案 Rails.application.class将为您提供应用程序的全名(例如YourAppName::Application)。从那里您可以使用Rails.application.class.parent获取模块名称。 关于ruby-on-rails-应用程序的名称是否可以作为变量使用?,我们在StackOve

  10. ruby-on-rails - 如何从过时的 TZInfo 标识符中获取 Rails TimeZone 名称? - 2

    已经有一个问题回答了如何将“America/Los_Angeles”转换为“PacificTime(US&Canada)”。但是我想将“美国/太平洋”和其他过时的时区转换为RailsTimeZone。我无法在图书馆中找到任何可以帮助我完成此任务的东西。 最佳答案 来自RailsActiveSupport::TimeZonedocs:TheversionofTZInfobundledwithActiveSupportonlyincludesthedefinitionsnecessarytosupportthezonesdefinedb

随机推荐