我已经做了一年的 javascript 开发人员，但由于我在大学里很懒，所以我缺乏一些建筑/工程背景。 一开始，我用相对较小和简单的对象编写小脚本。
随着我的项目变得越来越大，我倾向于使用更大、更复杂的对象，这些对象反射(reflect)了我在应用程序的各个部分中使用的 4-5 种基本数据结构。
我正在寻找记录/跟踪这些对象结构的最佳方法，因为当我制作一个将使用其中一个对象的新模块时，我必须利用它们尊重它们的结构和接口(interface)，以便使用它们的上一个/下一个模块不会中断。
到目前为止我所做的就是记录这样的对象:
/** 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...
}
*/
这最终导致了大量的注释，这些注释在代码中很丑陋，而且也具有破坏性。
您能否建议一些方法来可视化我的对象/数据结构或记录它们，以便我可以快速记忆起它们应该是什么样子？
最佳答案
有几种工具可以实现这一点，但这里有一些:
- njsdoc - “NJSDoc 是一个 JavaScript 文档工具， 通过执行代码来工作。”
- JSDuck
- jsdoc
- YUIDoc
- Natural Docs
- DocumentJS
关于javascript - 如何跟踪我的数据结构？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/16586898/