如何跟踪我的数据结构？

我现在是一个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... 
} 
*/

这最终给这些都是代码丑陋和distructing过意见很大的部分。

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

来源

2013-05-16 giorgos29cm

您不必使用平面对象只：有时它是有益的使用复合对象，当每个属性对应到另一个（基本）对象。如果它由引擎，底盘等组成，但不是最基本的部件，使用Car对象要容易得多。 – raina77ow

我想你可能有兴趣在这里提供的信息： http://javarevisited.blogspot.gr/2011/08/code-comments-java-best-practices.html

这是关于Java，但它们也可以在Javascript中（其中的一些）

应用总结要点：

专注于代码的可读性
不要写什么代码在做
总是写您为什么要写这一段代码
应尽量将完成您的评论在尽可能少的话尽可能
始终把评论，而在源代码控制库commiting代码
给你的代码的同胞开发商了解

关于你的代码，我不得不说从个人经验来看，在前一行写评论而不是旁边的代码更清晰易读。例如

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

来源

2013-05-16 12:13:14

有几个工具，这些在那里，但这里有几个：

njsdoc - “NJSDoc是作品执行代码为JavaScript文档工具。“
JSDuck
jsdoc
YUIDoc
Natural Docs
DocumentJS

来源

2013-05-16 12:18:10 plalx

如何跟踪我的数据结构？

回答

相关问题