我来自Java编程背景。我知道如何在那里做文档。我们可以在java环境中记录一个类的每个方法和每个属性。
自去年以来,我一直在使用 MEAN 堆栈开发 Web 应用程序。起初,我只是为了自己的理解添加了单行注释。我认为应该有一些标准的方式来记录 Web 应用程序。
粗略地说,我有以下代码:
- Angularjs 控制器
- Angularjs 路由
- Angularjs 服务
- 在服务器端(节点)定义的 MongoDb 集合
- ExpressJS 配置代码
- ExpressJS 路由及其处理程序
- REST API
- Socket.IO 代码
简而言之,我想这样做:
- 注释形式的代码内部文档(标准方式)
- 制作单独的文档 word 文件或 HTML 文件
编辑
我并不是说我想做与 Java 类似的代码文档。我想了解如何以标准方式在基于 MEAN 的应用程序中执行此操作。那些使用 MEAN 样板的人知道客户端代码和服务器端代码有单独的文件夹。在其中,有用于配置、路由处理程序、身份验证、视图等的单独文件夹。
谢谢。