Question

我目前是一名初级工程师，热衷于学习最佳实践并扩展我的经验。我的问题涉及任何静态编程语言，如Java，C＃，C ++等。

当我编写代码时，我喜欢让它易于阅读。在我看来，阅读代码应该就像读书一样。它应该流畅优雅。然后，即使我不需要使用它们，我也会尽可能地预先添加this，super - base个关键字。当我想使用常量或静态变量/方法时，同样适用于当前类名。

因此，另一位开发人员可以快速进行远景。他知道这个方法或var是在当前类或母类中而无需转移到声明。您可以对我说，使用最近的IDE这样做很容易。但是，我知道很多人仍在与Vim，Emacs或其他没有这些奇特功能的编辑合作。

在解释时，我喜欢将我的练习与戏剧书进行比较。我们都读过至少其中一个，比如莎士比亚的麦克白。在书的开头回过头来了解谁是那个角色以及他在情节中有哪些部分，谁从未感到沮丧？你这么做了很多次，对吗？

我的问题可能与文学编程实践有关。但是，我认为Donald Knuth的建议更多是关于为代码添加注释和添加宏。

所以我想知道您对这些做法的意见和反馈。我做得太多了吗？我应该保持简单吗？我打破了OOP规则吗？

以下是代码示例：

class Bar {
    protected int _motherVar;

    public aBarMethod() { }
}

class Foo extends Bar {
    private static List<String> _strings;

    private int _myPrivateVar;

    public void aMethod() {
        super.aBarMethod();

        this._myPrivateVar++;
        super._motherVar -= 2;
    }

    public static String anotherMethod() {
        String outcome = "";

        for (String s : Foo._strings) {
            outcome += s;
        }

        return outcome;
    }
}

Answer 1

你关心这件事是件好事。与此同时，每个程序员都对此感到抱怨。

我的一个观点是，虽然现代显示器有大量像素，但您会认为这意味着程序员可以在屏幕上看到更多代码。它似乎意味着代码是如此膨胀的空白，内容被推离屏幕。这使得代码看起来更“可读”，因为你可以少阅读：）

我的另一个观点是，没有多少可读性可以使代码理解为不在你理解概念的人。我认为程序员工作的一个重要部分是教育读者了解正在做什么的基础知识。没有它，他们就不会“得到它”。这不好，因为他们可能决定重新编写它（并打破它）。

Answer 2

为了使代码看起来不错，首先需要做的是制作正确的制表符和空格，以便代码的对齐方式与易于查看语句分组的方式一致。其他一切，无论你是否将变量命名为myVariable＆＃39;或者＆＃39; my_variable＆＃39;，只是您的偏好问题。尽可能多地评论代码行也是一种很好的做法。一段时间后返回代码时，这确实很有帮助。

使用静态语言编码时的样式指南

2 个答案: