标签: code-organization

我一直在运行StyleCop而不是一些C#代码,并且它一直报告我的using指令应该在命名空间内.

是否存在将using指令放入命名空间而不是命名空间外的技术原因？

如果您正在编写库或应用程序,那么单元测试文件会在哪里进行？

将测试文件与主应用程序代码分开是很好的,但将它们放入app根目录内的"tests"子目录中是很尴尬的,因为这会导致导入您将要测试的模块变得更加困难.

这里有最好的做法吗？

当我承担任何复杂的R项目时,我的脚本会很快变得混乱.

我可以采用哪些做法,以便我的代码永远乐于与之合作？我在考虑类似的事情

• 在源文件中放置函数
• 何时将某些内容分解为另一个源文件
• 什么应该在主文件中
• 使用函数作为组织单元(鉴于R使得难以访问全局状态,这是否值得)
• 缩进/换行做法.
  • 治疗(如{？
  • 把东西放在1或2行？

基本上,组织大型R脚本的经验法则是什么？

在#include.c文件中,.c文件是否可以(或者甚至是推荐/良好实践)？将它们包含在项目文件中会发生什么？

我开始使用Python(现在是时候试一试了),我正在寻找一些最佳实践.

我的第一个项目是一个在多个线程中运行命令行实验的队列.我开始得到一个很长的main.py文件,我想打破它.一般来说,我在寻找:python程序员如何组织多个源文件？是否有适合您的特定结构？

我的具体问题包括:

1. 每个班级应该在一个单独的档案中吗？
2. 我应该如何组织相对于源代码的单元测试？
3. 我应该在哪里放置doc注释,特别是那些用于命令行操作的注释？
4. 如果我使用多个目录,如何在它们之间导入类？

我可以通过反复试验得出我自己的一些结论,但我宁愿从好的东西开始.

因此,在面向对象的世界中花费了多年的代码重用,设计模式和最佳实践总是被考虑在内,我发现自己在Spark世界中的代码组织和代码重用方面有些挣扎.

如果我尝试以可重用的方式编写代码,它几乎总是带来性能成本,我最终会将其重写为适合我的特定用例的最佳代码.这个常量"为这个特定用例编写最佳内容"也会影响代码组织,因为当"它们真的属于一个整体"时,将代码拆分成不同的对象或模块是困难的,因此我最终只得到很少的"上帝"对象包含长复杂变换链.事实上,我经常认为,如果我在面向对象世界工作时看到我现在正在写的大部分Spark代码,我会畏缩并将其视为"意大利面条代码".

我上网试图找到某种等同于面向对象世界的最佳实践,但没有太多运气.我可以找到一些函数式编程的"最佳实践",但Spark只增加了一个额外的层,因为性能是这里的一个主要因素.

所以我的问题是,你们中的任何人都有Spark专家发现了一些你可以推荐的编写Spark代码的最佳实践吗？

编辑

正如评论中所写,我实际上并没有希望有人就如何解决这个问题发表答案,而是我希望这个社区中的某个人遇到一些Martin Fowler类型,他曾在某处写过som文章或博客帖子关于如何解决Spark世界中代码组织的问题.

@DanielDarabos建议我举一个代码组织和性能相互矛盾的例子.虽然我发现我在日常工作中经常遇到这方面的问题,但我觉得把它归结为一个很好的最小例子有点困难;)但我会尝试.

在面向对象的世界里,我是单一责任原则的忠实粉丝,所以我要确保我的方法只对一件事负责.它使它们可重复使用并且易于测试.因此,如果我不得不计算列表中某些数字的总和(匹配某些标准)并且我必须计算相同数字的平均值,我肯定会创建两个方法 - 一个计算总和,一个计算平均值.像这样:

def main(implicit args: Array[String]): Unit = {
  val list = List(("DK", 1.2), ("DK", 1.4), ("SE", 1.5))

  println("Summed weights for DK = " + summedWeights(list, "DK")
  println("Averaged weights for DK = " + averagedWeights(list, "DK")
}

def summedWeights(list: List, country: String): Double = {
  list.filter(_._1 == country).map(_._2).sum
}

def averagedWeights(list: List, country: String): Double = {
  val filteredByCountry = list.filter(_._1 == country) 
  filteredByCountry.map(_._2).sum/ filteredByCountry.length
}

我当然可以继续尊重Spark中的SRP:

def main(implicit …

我们有java和flex项目在起作用.我们目前有1个基本pom,其中包含我们要用于两个项目的配置.问题是:flex项目继承javadoc和pmd的配置,例如,他们不想要.

我想要做得更干净一点,有一个真正的基础,然后是一个java-base-pom和一个flex-base-pom.但是,如何在具有flex部分和java部分的多模块中工作？

我们有自己的应用程序的插件,我们使用以下结构:

• 我-插件
  • my-plugin-client(flex)
  • my-plugin-server(java)

my-plugin只包含一个带有section的pom.xml.我会使用my-plugin pom.xml作为两者的父级,但是我也不能将java base-pom或flex base-pom也用作父级.对此最好的评价是什么？

我最近一直在努力理解组织jQuery代码的最佳方法.我之前问了另一个问题,我认为我不够具体(在这里的问题中找到).

我的问题是,你做一个应用程序越丰富,你的客户端就越快失控.考虑这种情况......

//Let's start some jQuery
$(function() {        
    var container = $("#inputContainer");

    //Okay let's list text fields that can be updated
    for(var i=0; i < 5; i++) {

        //okay let's add an event for when a field changes
        $("<input/>").change(function() {

            //okay something changed, let's update the server
            $.ajax({
                success:function(data) {

                    //Okay - no problem from the server... let's update
                    //the bindings on our input fields
                    $.each(container.children(), function(j,w) {

                        //YIKES!! We're deep in here now!!
                        $(w).unbind().change(function() {

                            //Then insanity …

JAVA - NETBEANS

这是一个IDE问题

我总是使用折叠方法,因为我希望能够一起看到我的方法.这有点耗时,因为我必须使用鼠标滚动到方法的声明并单击 - (减号)图标.然后分别转到我想要处理的方法并单击+(加号)图标.

有没有办法通过键盘快捷键来进行折叠(分别是扩展)？

我最近开始学习Java,发现很奇怪每个Java类必须在一个单独的文件中声明.我是C#程序员,C#没有强制执行任何此类限制.

为什么Java会这样做？有任何设计考虑因素吗？

编辑(基于几个答案):

为什么Java现在还没有在IDE时代消除这种限制？这不会破坏任何现有代码(或者它会吗？).