Javascript 如何跟踪我的数据结构？

我已经是一名javascript开发人员一年了，但我缺乏一些建筑/工程背景，因为我在大学里很懒。 一开始，我用相对较小且简单的对象编写小脚本

随着我的项目越来越大，我倾向于使用更大、更复杂的对象，这些对象反映了我在应用程序的各个部分中使用的4-5种基本数据结构

我正在寻找记录/跟踪这些对象的结构的最佳方法，因为当我创建一个使用它们的新模块时，我必须使用它们，它们将尊重它们的结构和接口，以便使用它们的前一个/下一个模块不会中断

到目前为止，我一直在做的是记录这样一个对象：

/** description of the object/data structure
var myObject = {
    property1: "", //explain here what is this property and what type it is (number,string etc)
    property2:blabla,
    etc...
}
*/

这最终导致了大量的注释，这些注释在代码中很难看，并且也破坏了代码

---

你能建议一些方法来可视化我的对象/数据结构或记录它们，以便我能快速回忆它们应该是什么样子吗

我想您可能对这里提供的信息感兴趣：

这是关于java的，但它们也可以应用于Javascript（其中一些）

总结要点：

关注代码的可读性

不要写代码正在做的事情

总是写下你为什么要写这段代码

始终尝试用尽可能少的话来完成你的评论

在源代码管理存储库中提交代码时始终放置注释

将您的代码交给其他开发人员理解

关于您的代码，我必须说，根据个人经验，我发现在前一行而不是代码旁边写评论更清晰、更容易阅读。 例如

---

有几种工具可以实现这一点，但这里有一些：

• -“NJSDoc是一个用于JavaScript的文档工具 通过执行代码来工作

---

您不必只使用平面对象：有时，当每个属性对应于另一个（基本）对象时，使用复合对象是有益的。如果汽车对象由发动机、底盘等组成，但不是最基本的部件，那么使用汽车对象要容易得多。

var myObject = {
    //explain here what is this property and what type it is (number,string etc)
    property1: "", 
    property2:blabla,
    etc...
}