草庐IT

c# - 如何创建和维护代码重用库?

coder 2023-11-12 原文

我正在尝试建立一个可重用代码的存储库。我正在考虑让每个可重用代码模块都有一定的“成熟度”等级。评级将被定义为可重用代码在一组特定要求中的级别。最高成熟度级别将是一组预定义要求的最高标准。

例如:
等级;要求;说明
0级;代码是合法使用的;该代码在商业行业/跨多个契约(Contract)/等中使用是否合法?
1级;基本代码线并满足 0 级要求;原型(prototype)代码、第三方工具等
2级;具有功能接口(interface)和注释,满足1级要求;每个类和函数的足够文档;能够根据评论确定功能
3级;遵守编码标准,满足二级要求;遵循定义的编码标准并通过代码检查实用程序测试
4级;包括测试用例并满足 3 级要求;有足够的测试用例来测试代码的所有功能
5级;经复用委员会批准,符合4级要求;由重用专家和同行审查并验证它满足所有成熟度级别

我想知道这个成熟度级别是否应该是一个层次结构,为了进入下一个级别,您需要满足所有先前级别的要求(如我上面所示)?

或者它是否应该是满足下一个级别的要求的子集?

例如,我们已经满足了 y 个要求中的 x 个,我们可以进入下一个级别(要求与上面提到的相同)。

0级,满足6项要求中的0项
1 级,满足 6 项要求中的 1 项
……

我看到子集方法的问题是一些要求应该有更强的权重,并且在这种方法中不会被考虑(除非我开始变得具体,比如满足 b 中的 a 和 y 中的 x, ETC)。但随后它可能会开始变得复杂。

以前有没有人这样做过,如果有,你是如何设置你的库的?您是否有成熟度级别或其他结构?任何输入将不胜感激。

最佳答案

设置代码重用存储库是一项艰巨的任务。主要困难不在于如何设置它,而在于如何传达存储库中各种库的存在。重用库只有在被使用时才是好的,只有在已知时才会被使用,只有在代码质量高且满足用户需求时才会被广泛使用。

我喜欢成熟度级别的想法,但正如其他人发布的那样,可能需要做大量的设置/构建工作。我想到了一种构建应用程序的类似方法——我称它们为置信水平。在应用程序构建领域,低置信度构建是指未通过单元测试的构建;中等置信度可能包括通过单元测试,但不通过集成测试等。这是与 QA 和用户沟通预期内容的良好机制。类似的机制可能适用于图书馆。

文档注释是必须的,并且必须像您在代码中一样小心翼翼地对待它们。评论应该传达什么、为什么、在哪里、何时、如何、哪个等。您的构建过程应该将文档发布到一个众所周知的位置(同样,沟通是关键)。

在沟通方面,时不时地展示一下那里的内容并没有什么坏处。再次!沟通。

因此,至少每个库的构建应该:

  • 发布库(可能通知订阅者)
  • 发布文档
  • 运行单元测试
  • 发布成熟度级别

至于成熟度级别,我会用“级别名称”和级别含义的描述来定义它们。发布向上或向下移动一个级别意味着什么的标准。实际上,现在我考虑了一下,也许您想要一组正交标准:代码级别、文档级别、使用策略(即必须具有 XYZ 许可证)和其他属性。 不过,我确实建议您以较小的增量来实现这一点。归根结底,向最终用户交付功能才是最重要的。

您还必须传达一种自然地将可重用位插入存储库的心态。开发人员通常必须有动力这样做。寻找重复和同行评审的静态代码检查工具只能做到这一点。必须有人实际执行将代码移动到存储库的工作。

最后,我建议您在存储库的设置、构建、维护和通信中尽可能多地使用工具支持。否则,就像任何非代码工件一样,您将面临一定量的熵,随着非代码工件变得过时,它会降低值(value)。

关于c# - 如何创建和维护代码重用库?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/1302141/

有关c# - 如何创建和维护代码重用库?的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  4. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  5. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  6. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过,我不想只删除标签,我想智能地保留尽可能多的格式。为插入换行符标签,检测段落并格式化它们等。输入非常简单,通常是格式良好的html(不是整个文档,只是一堆内容,通常没有anchor或图像)。我可以将几个正则表达式放在一起,让我达到80%,但我认为可能有一些现有的解决方案更智能。 最佳答案 首先,不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案,它会随着HTML的变化而崩溃,或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  7. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  8. ruby - 如何在 buildr 项目中使用 Ruby 代码? - 2

    如何在buildr项目中使用Ruby?我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序,我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/),但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻,因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  9. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时,rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  10. ruby-on-rails - Rails 源代码 : initialize hash in a weird way? - 2

    在rails源中:https://github.com/rails/rails/blob/master/activesupport/lib/active_support/lazy_load_hooks.rb可以看到以下内容@load_hooks=Hash.new{|h,k|h[k]=[]}在IRB中,它只是初始化一个空哈希。和做有什么区别@load_hooks=Hash.new 最佳答案 查看rubydocumentationforHashnew→new_hashclicktotogglesourcenew(obj)→new_has

随机推荐