如何跟踪我的数据结构？

Question

我是一名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...
}
*/

这最终导致了大量的评论，这些评论在代码中也很丑陋并且也在破坏。

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

Answer 1

有几种工具可供选择，但这里有一些：

• njsdoc - “NJSDoc是JavaScript的文档工具 通过执行代码。“
• JSDuck
• jsdoc
• YUIDoc
• Natural Docs
• DocumentJS

Answer 2

我想您可能对此处提供的信息感兴趣： http://javarevisited.blogspot.gr/2011/08/code-comments-java-best-practices.html

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

总结要点：

1. 专注于代码的可读性
2. 不要写代码在做什么
3. 总是写下你写这段代码的原因
4. 始终尽量用尽可能少的语言完成您的评论
5. 在源代码管理存储库中提交代码时始终发表评论
6. 将您的代码提供给其他开发人员以理解

关于你的代码，我不得不说，根据个人经验，我发现在前一行而不是代码旁边写评论更清晰易读。 E.g。

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