文档工具包含很少或不完整的代码

时间:2014-06-06 14:28:54

标签: javascript html hyperlink documentation generator

我正在寻找一个文档工具。我认为我的需求非常具体,但似乎存在的东西。我有搜索高低,我的最后一招是stackoverflow用户的想法。

这是我面临的问题。在像JavaScript这样的语言中,它实际上并没有经典的东方对象。

但是有一些方法可以使用prototype属性。 (如果你有点混淆coffeescript输出或打字稿)。

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

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

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所以我试过了什么。 我尝试过使用markdown。理由停止。很难创建可以单击并轻松导航的链接。请记住,这是一个GUI前端。开发人员可以浏览页面并理解该语言的某些功能。

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

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

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

Microsoft Word。是。我们可以输入,但要将其格式化需要相当多的时间。

HTML文档。到目前为止这是关闭的东西,但是需要太多时间来添加带有样式标记的相对链接的头标记。

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

如何在不生成任何代码的情况下获取像phpdoc这样的文档。我想打字然后生成它。

没有订阅服务。

我听过一些似乎可以在乳胶中找到解决方案的词,但还没有完全弄明白。

1 个答案:

答案 0 :(得分:0)

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