问题标签 [code-readability]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
5 回答
21998 浏览

php - 如何使 PHP 中的 SQL 查询更具可读性?

当 SQL 查询中的字段很长时,如何使其更具可读性?

例如:

0 投票
2 回答
272 浏览

c# - 编写此布尔表达式时,哪种风格更可取?

我知道这个问题在某种程度上是一个品味问题。我承认这不是我不明白的事情,这只是我想听听别人的意见。

我需要编写一个带有两个参数的方法,一个布尔值和一个字符串。布尔值在某种意义上(很快就会很明显)是多余的,但它是该方法必须接受两个参数的规范的一部分,并且如果布尔值具有“错误”值,则必须引发带有特定消息文本的异常. true 当且仅当字符串不为空或为空时,布尔值必须为。

所以这里有一些不同的风格来写(希望如此!)同样的事情。你觉得哪一个最易读,并且符合良好的编码习惯?

当然,也欢迎您提出其他可能性。消息文本"..."将类似于“如果 'useName' 为真,则必须给出名称,如果 'useName' 为假,则不允许使用名称”。

0 投票
1 回答
310 浏览

html - 输入代码中的返回行导致输出中元素之间的间隙/空白?

可能重复:
忽略 HTML 中的空格

我正在尝试在网页上将图像并排放置。这是我的 HTML:

但是,在我的网页上,这显示了每个图像之间的差距。我注意到,一旦我删除了使元素分开且可读的返回行,而是将所有元素放在一行上,差距就消失了。

无论如何我可以实现后者的输出但仍然有代码/输入看起来像前者?我真的很喜欢返回行(输入空格)给代码带来的可读性,但我不想要它在实际页面上创建的空白。如果有人可以解释为什么会这样和/或如何解决它,我将非常感激!:)

0 投票
1 回答
81 浏览

jquery - 在大型应用程序中安排 jquery 事件绑定的正确方法

在高度交互和动画客户端 Web 应用程序中工作时,我们高度依赖 jQuery 库并大量使用它们的事件。

在大型企业应用程序中,这导致事件、它们的回调以及进一步到它们的 4 位代码行的内部方法调用的大连接。这开始看起来像是一个装满面条的巨型容器或一个充满难以调试的 goto 标签的巨大程序。

我的问题是,我们如何才能以更干净、可读和可维护的方式安排事件、回调和相关过程?在 Java 中,我们可以有不同的设计模式和单独的类来处理这个问题。我们如何在javascript中实现这一点。

先感谢您。任何少数链接也将受到高度赞赏

0 投票
1 回答
355 浏览

code-readability - OpenCMIS/DotCMIS:我有 CmisFolder 和文件名,如何获取 CmisDocument?

我想得到这个 CMIS 远程文件的 CmisDocument server1/dir1/file1:.

我已经有 CmisFolder 用于server1/dir1.
我也有文件名"file1"作为字符串。

获取 CmisDocument 的任何优雅方式?

以下是我非常不雅的尝试

0 投票
3 回答
497 浏览

java - Java中的显式成员方法引用

基于以下示例:

有没有办法让我调用成员方法更明确(请参阅setLocation()setSize())?

我正在寻找一些东西this.setLocation()来明确我调用一个成员方法而不是来自外太空的东西。

0 投票
0 回答
169 浏览

javascript - 重构javascript代码的方法

我正在开发过去 3 个月的煎茶应用程序。

应用程序源包含几个 JS 文件,大约 20 个,每个文件平均包含 800 - 1000 行代码。代码完全混乱。它包含至少 20% 的不需要的死的、无法访问的代码。

现在手头的任务是清理所有内容并使代码更易于理解和维护。如果有人说要更改某些功能,我正在努力在代码中找到可以添加更改的正确位置。在这种情况下,我该如何处理手头的任务?

肯定会寻求一些可以减轻我工作量的自动化工具的帮助。提前致谢。

0 投票
1 回答
344 浏览

html - 如何使用 RDFa 编写/格式化 HTML 以便在源代码中易于人类阅读?

添加 RDFa 非常有趣,但往往会使我的源代码几乎无法阅读(即使编辑器有不错的语法突出显示)。例如:

我一般不喜欢密集标记,因此我经常更喜欢用 markdown 编写,但这在添加 RDFa 标记的上下文中似乎是不可能的,例如这个例子。

似乎有人可能会利用空格来使其更具人类可读性。是否有任何现有的工具或约定?(下面的示例只是来自!fmtvim 中的自动换行,通常看起来不错,但在这种情况下似乎不知所措)。

0 投票
2 回答
51 浏览

java - 静态和公共定位

我正在使用 Apache log4j (http://logging.apache.org/log4j/2.x/),我意识到在他们的实现中他们总是这样声明他们的函数:

代替

使用这种风格有什么好的理由吗?

0 投票
3 回答
1373 浏览

c# - 如何决定布尔运算符的使用、性能问题与可读性

甚至有两个以上的选项可供选择,这让我产生疑问,如果结果/结果相同,该选择哪一个。

.NET C# 以下情况下使用不同的运算符提出相同的问题,所以问题是,有经验的开发人员使用什么,我倾向于假设现成的运算符Equals会经历更多的处理动作。

您何时以及为什么会选择“传统”!Equals不是“传统” ==