我已经开始使用 JSDoc，到目前为止它很棒，但我想记录我的代码部分，比如 Visual Studio 有 #region。
我应该把它包裹在这样的 cmets 块中吗？
/**
* Region for calling express routes
*/
here goes code...
/**
* End region
*/
我只是在寻找更优雅的方式来做到这一点。
【问题讨论】：
标签： javascript comments jsdoc regions
SAPUI5: UI Development Toolkit for HTML5 文档讨论了 JSDocs 中部分/横幅 cmets 的缺陷。具体来说：
JSDoc 将任何以双星号 ( /** ) 开头的多行注释解释为文档注释后面的 JavaScript 符号的文档注释。 [...] 所以不要使用星号/星号来分隔横幅评论。您可以使用其他字符，例如
/* ==== */
或
/* ----- */
或者至少避免在开头使用双星号。
【讨论】：
JSDoc 没有提供类似的选项。 AFAIC 这也很有意义。它对记录 API 或提供一些 IDE 代码帮助有什么帮助？
#region允许您指定在使用 Visual Studio 代码编辑器的大纲功能时可以展开或折叠的代码块。在较长的代码文件中，可以方便地折叠或隐藏一个或多个区域，以便您可以专注于当前正在处理的文件部分。
甚至#region 上的文档都表示这是为了启用特定编辑器的功能。 JSDoc 不受某些编辑器的约束，而是用于帮助处理 API 文档。通过使用相当方便的编辑器，您不需要此类 cmets，而是使用编辑器提供的扩展器（例如 Webstorm、Visual Studio Code）。
请参阅http://usejsdoc.org 了解所有可用选项。
您可能希望“强制”编辑器分别折叠部分代码。这可以通过将其包装在某个语言对象（可在您喜欢的编辑器中折叠）或一对大括号中来实现。但是，如果您必须共享此代码，预计会被问到这对您有什么好处...
【讨论】：
// 评论风格，所以决定使用 jsdoc，它既适合阅读，又可以生成我的应用程序的文档。