代码很少或不完整的文档工具[关闭]

Question

我正在寻找一个文档工具。我猜我的需求非常具体，但似乎会存在。我有搜索高和低，我最后的手段是stackoverflow用户的想法。

这是我面临的问题。在像 JavaScript 这样的语言中，它并不真正具有经典的面向对象的性质。

但是有一些方法可以使用原型属性来做到这一点。 （如果您有点困惑，请查看 coffeescript 输出或打字稿）。

所以现在，一旦我们到达这里，我们需要记录代码，但我们现在没有想要使用的某些关键字。 比如class和extend。

如果你有点困惑，这里是一个例子

function Person(name){
   this.name=name;
}

function Person(name){
   return {
       name:name
   }
}

function Person(){
   console.log("hi i am a person");
}

所有这些都是有效的 javascript，如果没有人类来判断函数或类的意图，这几乎是不可能的。

例如

function Person(){
   console.log("hi i am a person");
}

///This is obviously not a class only an idiot would think so

Person.prototype.setUp=function(config){
    this.name=config.name;
    this.age=config.age;
}
///Ha-ha! got you it is going to be a class

这使得记录变得非常困难。

所以我想要的是一种创建不依赖于代码的文档的方法。如果我可以在单独的文件夹中创建它。

如果我有一棵这样的树。

src/

    People

           Person.js

           Man.js

           Woman.js

doc/

   index.html

   People
           Person.html

           Man.html

           Woman.html

手动执行此操作的问题是创建每个文件。给他们一个头部标签和样式，并在东西被移动时建立相对链接会产生问题。

我想要一些类似于从 phpdoc 生成的文档，其中包含所有样式和所有内容，我可以浏览旁边的类。包含文件夹结构和所有内容。

KK 所以我尝试了什么。 我尝试使用降价。停下来的理由。很难创建可以单击和轻松导航的链接。请记住，这应该是一个 GUI 前端。开发人员可以浏览页面并了解该语言的某些功能。

是的，当你上传 github 时，markdown 会被解析和理解，但它还不够好，需要在前端和本地工作。

维基 是但不是。这需要一个设置。这需要是一个设置较少的功能。

EverNote 你打算如何使用 Evernote 通过 github 进行同步。您可以链接并单击以跳转到不同的页面，但没有使用 VC 的选项。

微软Word。是的。我们可以打字，但要格式化需要相当多的时间。

HTML 文档。到目前为止，这是可行的，但需要太多时间来添加带有样式标签的相对链接的头部标签。

选项将所有html放在同一个文件夹中并使用_作为/这很乱。

如何在没有任何代码生成的情况下获得像 phpdoc 这样的文档。我想输入它然后生成它。

没有订阅服务。

我听说过一些话，似乎可以在乳胶中找到解决方案，但还没有完全弄清楚。

Answer 1

我不会将此标记为最终答案，但它肯定看起来很有希望http://daux.io/