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

Documentation Tool with Little or Incomplete Code

本文关键字:代码 工具 文档      更新时间:2023-09-26

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

这是我所面临的问题。在像JavaScript这样的语言中,它并没有真正具有古典对象的东方特性。

但是有一些方法可以用prototype属性做到这一点。(如果你有一点困惑,看看coffeescript输出或typescript)

现在,一旦我们到达这里,我们需要记录代码,但我们没有我们现在想要使用的某些关键字。例如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

手工操作的问题是创建每个文件。给它们一个head标签和样式,并设置相对链接,如果东西被移动了,就会产生问题。

我想要的东西,就像从phpdoc与所有的样式和包含的一切生成的文档,我可以只是浏览类在一边。包含文件夹结构和所有内容。

KK所以所以我尝试了什么。我试过降价。停下来的理由。很难创建可以点击和轻松导航的链接。记住,这是一个GUI前端。开发人员可以浏览页面并了解语言的某些特性。

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

维基是,但不是。这需要一个设置。这需要是一个较少设置的函数。

EverNote你应该如何通过github使用EverNote同步。您可以链接和点击跳转到不同的页面,但没有选项来使用VC。

Microsoft Word。是的。我们可以打字,但要把它格式化需要相当多的时间。

HTML文档。这是目前为止完成的工作,但需要太多的时间来添加那些头部标签与样式标签的相对链接。

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

我怎么能得到文档像phpdoc没有任何代码生成。我想先把它打出来,然后再生成。

没有订阅服务。

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

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