问题标签 [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 投票
2 回答
97 浏览

whitespace - 在网页源代码中添加空格,以便我可以阅读它

  1. 我很好奇我正在查看的网页。
  2. 我使用“view--page source”并获得一个带有 html 的窗口。
  3. 我将其剪切并粘贴到记事本++中。

  4. 我通过添加空格手动解析以使其可读。

有没有更好的方法来完成最后一步?我希望已经编写了一些东西来自动化这个过程,给用户一个可读的源文件版本。

谢谢你的帮助。

-账单

0 投票
5 回答
3523 浏览

coding-style - 如何使长参数列表可读?

我对函数中的长参数列表产生了一种自然的反感。虽然这在某种程度上是一件好事,但与代码重复或由于“手动内联”导致的冗长函数相比,有时长参数列表是两个弊端中较小的一个。至少让这些怪物中的一些人可读的好方法是什么?例如:

这在可读性方面得分并不高,但在很多情况下四个参数是相当合理的。

0 投票
5 回答
865 浏览

coding-style - 重函数调用嵌套的可读性?

我经常看到它认为不应该使用重度嵌套的函数调用,因为它们不可读。然而,使用临时变量反而会产生很多不必要的冗长,并迫使读者在心理上将每个临时变量与其所代表的内容联系起来。在查看 Lisp 代码通常格式化的方式时,我突然想到,如果您格式化它们以反映嵌套,嵌套函数调用实际上可以变得非常可读。例如:

以嵌套函数形式编写类似于第一个示例的内容,恕我直言,相当于在更多过程式代码中执行以下操作:

在这两种情况下,真正的问题是格式不正确,而不是过度嵌套。您如何评价格式良好的嵌套函数版本与临时变量版本的可读性/可理解性?你是否认为繁重的函数调用嵌套是不好的风格,即使它被格式化以获得最大的可读性?如果是这样,为什么?

0 投票
6 回答
1057 浏览

c# - foreach(... in ...) 或 .ForEach(); 就是那个问题

可能的重复:
C# foreach 与功能各自

这是一个关于可读性编码的问题。

我有一个XDocument和一个List<string>包含我需要屏蔽的敏感信息的元素名称(在此示例中替换为下划线)。

这可以用两种方式编写,使用传统的foreach循环,或者使用.ForEach带有 Lamba 语法的方法。

或者

您认为哪种方法最易读,为什么?如果您更喜欢第二个示例,您将如何呈现它以获得最大的可读性?

0 投票
4 回答
2254 浏览

python - 编码风格 - 将括号保持在同一行或新行上?

假设您正在调用一个函数,为了便于阅读,显然需要将语句分解为几行。但是,至少有两种方法可以做到这一点:

你会这样做吗:

或者您更愿意这样做:

或者,请建议您自己的格式。还请列出您使用特定格式的原因以及另一种格式有什么问题。

谢谢

0 投票
3 回答
1243 浏览

c# - 如何获得 Fry Graph 可读性公式的级别?

我正在一个应用程序(C#)中工作,它将一些可读性公式应用于文本,如 Gunning-Fog、Precise SMOG、Flesh-Kincaid。

现在,我需要在我的程序中实现 Fry-based Grade 公式,我理解公式的逻辑,几乎你取 3 100 个单词的样本并计算每 100 个单词的句子和每 100 个单词的音节的平均值,然后,您使用图表来绘制值。

是有关此公式如何工作的更详细说明。

我已经有了平均值,但我不知道如何告诉我的程序“去检查图表并绘制值并给我一个水平”。我不必向用户显示图表,我只需向他显示级别。

我在想也许我可以将内存中的所有值划分为级别,例如:

级别 1:句子平均在 10.0 到 25+ 之间,音节平均在 108 到 132 之间的值。

级别 2:句子平均值在 7.7 到 10.0 之间的值,等等。

但问题是,到目前为止,我发现定义级别的值的唯一位置是在图表本身中,而且它们并不太准确,所以如果我应用上面评论的方法,试图采取图表中的值,我的水平估计会太不精确,因此,基于 Fry 的等级将不准确。

所以,也许你们中的任何人都知道某个地方我可以找到基于 Fry 等级的不同级别的确切值,或者你们中的任何人都可以帮助我思考解决这个问题的方法。

谢谢

0 投票
3 回答
1439 浏览

javascript - 可读性和 IF 块括号:最佳实践

我正在为学习 JavaScript 基础的 1 级 uni 学生准备一个简短的教程。任务是验证电话号码。该号码不得包含非数字,并且长度必须为 14 位或更少。以下代码摘录是我想出的,我想让它尽可能可读。

一个我不能完全回答自己的简单问题,想听听您的意见:如何定位周围(最外面的)括号?很难看出普通括号和大括号之间的区别。你通常把最后)一个条件和最后一个条件放在同一行吗?您是否将第一个开口保持(在一条线上?您是否也将每个单独的子条件括在括号中?您是将第一个(与最后一个水平对齐),还是将最后一个)if?

您是保留) {在单独的行上,还是将最后)一个与最后一个子条件放在同一行,然后将开口{放在新行上?或者你只是把它) {和最后一个子条件放在同一行?

社区维基。

编辑 请仅发表关于括号的使用和放置的意见。代码不需要重构。这适用于几周前才接触 JavaScript 的人。我不是在征求意见如何编写代码以使其更短或性能更好。我只想知道如何在 IF 条件周围放置括号。

0 投票
2 回答
5182 浏览

css - Visual Studio 中的自定义格式文档选项。格式化 CSS 标签

当我在 VS2008 中工作时,我经常使用 Ctrl+K+D,因为它可以节省很多时间。

但在 CSS 文件中,此命令以我不太喜欢的方式格式化文档。

例如,当我自动格式化文档时,

但是,我喜欢以这种方式格式化标签,因为它更容易阅读(在我看来):

那么,有什么方法可以实现吗?

“标签特定选项”功能似乎是我需要的东西,但我不太确定如何做到这一点。

谢谢。

0 投票
6 回答
21680 浏览

coding-style - 如何在研究报告中格式化代码

我目前正在写一份正式的研究报告,我将在这份报告中包含代码。

问题:在研究报告中显示代码是否有一种可接受的方式?我在考虑字体、间距等方面,以及代码是否应该显示文档中或附录中。

代码将是 JavaScript 和 PHP。代码的任何部分都不会超过 25 行(所以它们只是片段)。大约会有六个片段。每个片段都会有几段解释代码中发生的事情,并讨论其优缺点。

我与将向其提交报告的机构没有联系,他们也没有发布关于如何格式化代码的指南(请不要质疑这些点)。

0 投票
6 回答
1405 浏览

coding-style - 为什么那里有这么多缩进不佳的代码?

我用非 Python 语言浏览开源项目的代码越多,我就越意识到似乎很多程序员不相信适当的缩进。(我不会专门提到任何项目以避免有人把这个问题看得太个人化。)通常代码是缩进的,但在某种程度上与标准风格有很大不同,它让我发疯,尤其是在旧的/粗糙的代码中。我注意到,当我使用类 C 语言编写代码时,我倾向于正确地缩进,就像使用 Python 编写代码时一样,除了调试代码之外,我实际上想像拇指疼痛一样伸出援手。鉴于使用现代 IDE 修复不正确的缩进是多么容易,有什么理由不虔诚地保持缩进与大括号同步?