Add custom comments to any JSON file with ease.
Open any JSON file in your current workspace, hover over any key, and click on Add Comment in the hover tooltip. You can then input your comment, and it will be added. The comments will be displayed above the commented keys in the form of CodeLens.
Simply click on the comment content and select Remove Comment to delete it.
By default, the comment contents are saved in the json-comments section of the package.json file in your current workspace. If you want to modify the save location, you can do so in the workspace configuration.
Modify the Save File and Entry Key in the workspace configuration for JsonComments. For example:js
No, all comments are by default saved in the section of the package.json file. The original JSON file remains unchanged.
No, as long as you include the file where the comments are saved in the commit, the comments will not be lost.
Can other team members see the comments? Yes, other team members can see the comments by installing the JsonComments plugin.
The comments will not be lost as long as the JSON path of the commented key remains unchanged. JsonComments saves the comments based on the JSON path as the key.
No, JsonComments will automatically update the comment information when moving or renaming the JSON file to ensure that the comment information is not lost. However, if you move or rename the file outside the VSCode environment, the associated comment information will be lost. In this case, you can manually modify the path in the json-comments section of the package.json file.