Questions tagged «code-formatting»

着重于代码的易读性和外观的一致性:词法级可懂度是编码风格的基本要素

30
大括号应该出现在自己的行上吗?[关闭]
大括号应该放在自己的行上吗?你怎么看待这件事? if (you.hasAnswer()) { you.postAnswer(); } else { you.doSomething(); } 还是应该 if (you.hasAnswer()) { you.postAnswer(); } else { you.doSomething(); } 甚至 if (you.hasAnswer()) you.postAnswer(); else you.doSomething(); 请建设性!解释为什么,分享经验,并以事实和参考作为支持。

17
对所有开发人员强加相同的代码格式是一个好主意吗?
我们正在考虑在我们的项目中采用单一标准代码格式(在Eclipse中具有保存操作的自动格式)。原因是,当前有几个(> 10)开发人员使用的代码格式存在很大差异,这使一个开发人员更难处理另一开发人员的代码。相同的Java文件有时会使用3种不同的格式。 因此,我认为优点很明显(可读性=>生产率),但是强加此方法是个好主意吗?如果没有,为什么? 更新 我们所有人都使用Eclipse,并且每个人都知道该计划。大多数人已经使用了一种代码格式,但是由于某些人倾向于坚持自己的代码格式,因此未强制执行。由于上述原因,有些人宁愿执行它。

30
在纸上打印代码是否常见?[关闭]
我喜欢将代码行保持在80个字符以内,因为: 我不必进行任何水平滚动; 我知道如果超出此限制,该行可能太复杂了;和 它可以很好地打印在纸上。 关于后者,我只遇到了几个实际打印出代码以供查看的人(我就是其中之一)。那么打印代码有多普遍?

29
如何在代码中使用空行?
关于花括号放置的讨论中已经有关于空白的一些评论。 我本人倾向于在我的代码上加上空白行,以试图将“逻辑”组中的所有内容隔离开来,并希望使下一个人更容易阅读我刚刚生成的代码。 实际上,我会说我像编写代码那样构造代码:我创建一段不超过几行(绝对短于10行)的段落,并尝试使每个段落都是独立的。 例如: 在一个类中,我将组合在一起的方法,同时将它们与下一组分隔为空白。 如果我需要写评论,通常会在评论前放一个空白行 在一种方法中,我在过程的每一步都写一个段落 总而言之,我很少有超过4/5的行聚集在一起,这意味着代码非常稀疏。 我不认为所有这些空白都是浪费的,因为我实际上使用它来构造代码(实际上是使用缩进),因此,我觉得值得这样做。 例如: for (int i = 0; i < 10; ++i) { if (i % 3 == 0) continue; array[i] += 2; } 我认为这两个陈述具有明确的不同目的,因此应该分开以使其显而易见。 那么,如何在代码中实际使用(或不使用)空行呢?

14
为什么富代码格式更不常见?
我正在阅读《代码完成》,在有关布局和样式的章节中,他预测代码编辑器将使用某种格式的富文本格式。这意味着,而不是像这样的代码 Procedure ResolveCollisions { Performs a posteriori collision resolution through spatial partitioning algoritm } ( CurrentMap : SpriteContext, PotentialColliders: SpriteList ) var Collider : Sprite, Collidee : Sprite, Collision : SpriteCollision begin DoStuff(); end. 它可能看起来像这样: 程序 ResolveCollisions 通过空间划分算法执行后验碰撞解决 参量 CurrentMap : SpriteContext PotentialColliders : SpriteList 局部变量 Collider : Sprite Collidee …

5
使用VCS时格式化代码是一件坏事吗?
在承诺确保正确完成之前,几乎总是格式化我的代码。我团队中的大多数人都不在乎,也不总是总是正确地格式化他们的代码(次要的事情不会影响代码,但是会在尝试维护代码时影响可读性)。 我最近安装了具有选项“保存时格式化”的VS电动工具,并对以前未格式化的文件进行了更改。开发副总裁只是来找我,并谴责我进行格式化,因为它在合并工具中显示为几乎整个文件都被更改了,而不是一两行(所以他看不到我很容易地修改了什么),并且告诉我以后禁用保存格式。尽管我了解这种担忧,但是我发现有时很难对未格式化的代码进行分类,而IMO应该始终始终对其进行正确格式化。请注意,我不仅随心所欲地重新格式化,而且在编写代码时,我将使用电动工具或按key命令设置文本格式以使其易于阅读,并且在SVN中显示为修改。 所以我问,总是格式化代码实际上是一件坏事吗?他的担忧是否比确保代码可读性更有效?

5
使用自动格式化在Eclipse中格式化代码是一个好主意
我使用eclipse进行编码,而我们使用的语言是Java。一旦有人建议使用自动格式化程序(CTRL + SHIFT + F)来正确格式化代码,尽管此命令确实对代码进行格式化,但有时我会觉得整体外观很奇怪,并且实际上不太可读。 那么这是推荐做的事情吗?如果不是,在eclipse中格式化我们的代码会更好吗?


6
代码格式化SQL查询
我应该在不同的行中中断SQL查询吗?例如,在我正在进行的项目中,我们有一个查询,该查询占用1600列!1600 +制表符。我写了这样的查询: "SELECT bla , bla2 , bla FROM bla " . "WHERE bla=333 AND bla=2" . "ORDER BY nfdfsd ..."; 但是他们要求我将它们放在一行中,并说我的样式格式不好。为什么这是不好的做法?

3
整理存储在代码中的SQL查询的最佳方法?(还是应该?)[关闭]
已关闭。这个问题需要更加集中。它当前不接受答案。 想改善这个问题吗?更新问题,使其仅通过编辑此帖子来关注一个问题。 5年前关闭。 我确信我不是唯一一个在看到一页充满SQL查询的代码时感到沮丧的人。ActiveRecord和其他ORM模式有助于减少项目中使用的大量SQL,但是在许多复杂查询的情况下,SQL的使用似乎不可避免。 我正在寻找有关如何与其余代码(或外部代码)一起组织SQL查询的意见,以防止其散布到各处?一个明显的想法是使用视图,但是在处理多个大型索引表等时,视图通常会成为性能问题的源头。 编辑1-我假设您已经将其分离到模型层中

4
使用自动设置文本格式是一种好习惯吗?
我正在使用Eclipse,并将以它为例进行讨论,但是我确信在任何其他IDE中都是如此。 Eclipse拥有的CTRL- Shift- F命令,它自动格式化你的代码。使用这种格式是否是一种好习惯?我要问的是一个大型项目,其中可能有许多程序员在处理相同的文件,而所有这些程序都由CSV系统管理。 谢谢!

2
格式化SQL代码的算法
我需要一个用于内部使用的工具,该工具将格式化SQL代码(SQL Server / MySQL)。 有各种各样的第三方工具和在线网站可以执行此操作,但并非完全符合我的需要。 因此,我想编写适合自己需求的工具。 第一个问题是否存在有关应如何格式化SQL代码的标准或约定?(我尝试过的工具采用不同的格式) 第二个问题,我应该如何完成这项任务?首先应该将sql查询转换为某种数据结构,例如Tree吗?

3
代码格式:在类文件中基于调用层次结构布置函数?
鲍勃·马丁(Bob Martin)的“干净代码”的建议让我挠头。 到目前为止,我或多或少都遵守.Net指南,该指南按类型(属性,ctor,函数)和可见性(公共/保护/私有)对类成员进行分组。提示一开始似乎很麻烦..但是“可能有用”。我个人遇到过我喜欢这种布局的情况-当您处于正确的呼叫链中时,更容易进行深入研究。 提示背后的想法听起来不错,但其他情况(如“让我看看此类的公共界面”)可能会变得更糟。鲍勃叔叔也许是依靠小类和IDE对查看类型的支持... 有人试过很长时间了吗? 更新:好像是一个代码片段 class SomeType() { /// fields, ctors, et. all public void Method1() { // calls HelperMethod1 and HelperMethod2 } private void HelperMethod1 { // calls HelperMethod3 } private void HelperMethod3 {} private void HelperMethod2 {} public void Method2 () { // and so on... } …
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.