javascript - 了解 JavaScript 中的源代码管理和文档

Question

我在 Github 上遇到了一些基于 Javascript 的大型项目，这些项目似乎是由许多单独的 Javascript 文件构建的，但作为单个脚本分发。我还注意到其中一些似乎在自动生成文档的源代码中有特殊标记。以下是Leaflet类的源代码CircleMarker示例：

import {Path} from './Path';
import * as Util from '../../core/Util';
import {toLatLng} from '../../geo/LatLng';
import {Bounds} from '../../geometry/Bounds';

/*
 * @class CircleMarker
 * @aka L.CircleMarker
 * @inherits Path
 *
 * A circle of a fixed size with radius specified in pixels. Extends `Path`.
 */

export var CircleMarker = Path.extend({

// @section
// @aka CircleMarker options
options: {
    fill: true,

    // @option radius: Number = 10
    // Radius of the circle marker, in pixels
    radius: 10
},

我想我理解importandexport语句在运行时的作用，但是这些语句在将源文件组装到复合脚本中是否有作用？如果是这样，它是标准化的，还是特定于某些工具的？同样，@markup评论是标准格式吗？这一切都可以在哪里描述？对我来说，仅查看 repo 中的源代码并不明显。

为了澄清，我正在寻找可以帮助我研究如何在我自己的项目中应用这种模块化和自我文档的答案。我不是在寻找针对特定工具的建议，或者专门针对 Leaflet 的建议，尽管如果上面的示例是特定于工具的，那么很高兴知道。相反，我更感兴趣的是找出执行此操作的标准或最佳实践方式。

标签： javascriptmoduledocumentation