有什么方法可以评论或更好地组织一个凉亭吗?json文件

Is there any way to comment in or better organize a bower.json file?

本文关键字:一个 凉亭 文件 json 方法 什么 评论 更好      更新时间:2023-09-26

我有一个非常大的项目,有许多下级依赖项。在许多情况下,不清楚这些依赖项是否仍然在应用程序中使用,或者是否出于某种原因选择了指定的版本。理想情况下,我希望能够为每个依赖项添加注释,以说明应用程序的哪个部分需要它,这样当应用程序中的功能被删除时,我们也可以从bower_components中删除不必要的包。比如:

// videojs plug-in for adding navigable waveforms; used by the video component
"videojs-wavesurfer": "^1.2.2"

不幸的是,json不支持注释,但是有任何可能的解决方案来注释或更好地组织一个展览室吗?Json文件,使其更容易理解?

不能在JSON文件中添加注释。JSON是为数据而不是其他的。

如果您想要记录您的依赖项,请考虑在README文件中添加一个部分,其中包含与依赖项相关的所有信息。

注释JSON文件的经典方法是添加假条目,希望这些条目将被消费者忽略,例如:

"video-wavesurfer-comment": 
  "videojs plug-in for adding navigable waveforms; used by the video component"

对于较长的注释,使用数组:

"video-wavesurfer-comment": [
  "videojs plug-in for adding navigable waveforms; used by the video component",
  "Remove this for the non-video version."
]

当然,你必须把这些放在别人不会试图解析它们的地方。例如,他们不能进入"dependencies":