你是否在代码中专门为“在项目中查找”添加任何内容？

前几天，在一次团队会议中，我们提出了一个代码格式化想法，我认为它非常有趣。 它与以这样一种方式格式化代码有关，即使用任何代码编辑器的“在项目中查找”功能更容易找到要查找的内容。

以下是内容。

在 JavaScript 中声明函数时，在函数名称后和左括号前添加一个空格，例如…

function doSomething () {

}

doSomething 和 () 之间的空格完全没问题。 然后，当您调用函数时，不要使用空格，像这样

doSomething();

这只是一个语法约定。

但现在，“在项目中查找”更有用。 如果我们想快速找到定义该函数的位置，我们可以搜索“doSomething ()”，如果我们想找到使用该函数的实例，我们可以查找“doSomething()”。

您也可以将该想法扩展到类或其他任何内容。

class myThing {

  constructor () {

  }

  doThing () {

  }  

}

let example = new myThing();
example.doThing();

我认为值得这样做。

它让我想起当我需要查找 Ruby 方法的定义时，我总是可以搜索“def foo”，因为“def ”是创建该方法所必需的。

我可以想象这样一种情况，在 CSS 中定义基本类可能很有用，例如 .module {，但如果它是变体或嵌套的，或者出于任何其他原因再次使用… .module{。

这是一个经典示例

// TODO: 😅

— Charlotte Dann (@charlotte_dann) 2017 年 9 月 10 日

在整个代码库中留下 TODO 注释，将“在项目中查找”用于“TODO”变成一个即时的待办事项列表。 当然，这甚至可以更加细致，包含诸如优先级级别和分配之类的内容。 也许还可以像夏洛特建议的那样，使用表情符号来帮助！

这是一个有趣的示例

使用长类/变量，用注释标记未来的重构点。 你在找什么？

— Chris Pauley (@ChrisPauley) 2017 年 9 月 10 日

我喜欢“长名称”的想法。 我想，名称越长，描述越详细，就越容易搜索和获得特定结果（避免像使用非常简单的名称那样重复匹配）。

注释是放置要搜索内容的好地方。 我经常使用一种约定，如果我想要让人们知道是我留下了注释，我会在注释中加上自己的名字，但这并不一定是针对我自己的。

.thing {
  overflow: hidden; /* [Chris]: ugkghk this fixed a layout thing but I didn't have time to figure out exactly why. */
}

一些回复

在每个模板的顶部，我添加“<!– Start [模板名称] –>”，在底部添加相同的内容，但改为“End”。 这有助于 FIP 和浏览器渲染的代码。

— Dale Henry Geist (@dalehenrygeist) 2017 年 9 月 10 日

我使用一致的自然语言为事物命名，因此当文档过时时，至少代码本身仍然很容易上手。

— John James Jacoby (@JJJ) 2017 年 9 月 10 日

不在代码本身中，而是在 Sublime 设置的 folder_exclude_patterns 中，您可以传入一个要从所有搜索中排除的文件夹数组。

— Ian C Woodward (@IanCWoodward) 2017 年 9 月 10 日

// TODO 😕
// FIXME 😲
// WT* 😤💣

— Kamran Ahmed (@kamranahmedse) 2017 年 9 月 10 日

ctags 是一个救星。

— Harry Roberts (@csswizardry) 2017 年 9 月 10 日

命名约定，伙计！ BEM 风格的那些类 –thing 总是比 thing 更容易找到

— James Bosworth (@fltwhte) 2017 年 9 月 11 日