如何跟踪我的数据结构？

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的文档工具，它通过执行code__."
• 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. 在提交源代码控制存储库中的代码时，总是试着用尽可能少的话来完成你的注释

<代码>H112将你的代码交给其他开发人员以了解<代码>H213<代码>G214

关于你的代码，我不得不说，根据我的个人经验，我发现在前一行上写注释比在代码旁边写注释更清晰、更容易阅读。例如。

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