Javascript JSDoc-如何记录代码区域

我已经开始使用JSDoc，到目前为止这是一件很棒的事情，但是我想像VisualStudio一样记录我的代码部分

我应该像这样把它包装成一块评论吗

/**
 * Region for calling express routes 
 */

here goes code...

/**
 * End region
 */

---

我只是在寻找更优雅的方法来实现这一点。

JSDoc没有提供类似的选项。这也很有道理。它在编写API文档或提供IDE代码帮助方面有什么帮助

#region

允许您指定一块代码，在使用Visual Studio代码编辑器的大纲功能时可以展开或折叠该代码块。在较长的代码文件中，可以方便地折叠或隐藏一个或多个区域，以便您可以关注当前正在处理的文件部分

即使是

#region

上的文档也会说明这是为了启用特定编辑器的功能。JSDoc不绑定到某些编辑器，而是用于帮助编写API文档。通过使用相当方便的编辑器，您不需要这样的注释，而是使用编辑器提供的扩展器（例如Webstorm、Visual Studio代码）

有关所有可用选项，请参见

您可能希望“强制”编辑器单独折叠部分代码。这可以通过将其包装在某个语言对象（可在您喜爱的编辑器中折叠）或一对大括号中来实现。但是，如果您必须共享此代码，那么您可能会被问到这对……有什么好处。

文档谈到了JSDocs中节/横幅注释的陷阱。具体而言：

JSDoc将任何以双星号（/**）开头的多行注释解释为文档注释后面的JavaScript符号的文档注释。 [...] 因此，不要使用星号/星号作为单独的横幅注释。例如，您可以使用其他字符

或

或者至少在开始时避免使用双星号

---

你对编辑器的看法是对的，我使用的是sublime，但我不喜欢自己对

/

的评论风格，所以决定使用jsdoc，它既适合阅读，也可以为我的应用程序生成文档。

/* ==== */ 

/* ----- */