0

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

这最终导致了大量的注释，这些注释在代码中很丑陋，也很混乱。

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

4

2 回答 2

2

有几种工具可以做到这一点，但这里有一些：

于 2013-05-16T12:18:10.980 回答
0

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

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

总结关键点：

  1. 注重代码的可读性
  2. 不要写代码在做什么
  3. 总是写下你写这段代码的原因
  4. 始终尝试用尽可能少的词完成您的评论
  5. 在源代码控制存储库中提交代码时始终添加注释
  6. 将您的代码提供给其他开发人员以了解

关于您的代码，我不得不说，从个人经验来看，我发现在上一行而不是在代码旁边写注释更清晰易读。例如

var myObject = {
    //explain here what is this property and what type it is (number,string etc)
    property1: "", 
    property2:blabla,
    etc...
}
于 2013-05-16T12:13:14.430 回答