fundoc:Fundoc-生成文档的正确方法

时间:2024-05-09 13:00:16
【文件属性】:

文件名称:fundoc:Fundoc-生成文档的正确方法

文件大小:5.73MB

文件格式:ZIP

更新时间:2024-05-09 13:00:16

rust cli documentation literate-programming documentation-generator

语言不可知文档生成器。 写在锈 :crab: Fundoc-生成文档的正确方法。 项目中的业务功能可以用不同的文件甚至不同的技术实现。 Fundoc可以合并这些功能的所有描述,并将它们放在适当的文件中。 Fundoc的主要目标: 允许您保留所有文档以及代码。 分开的文档和代码使支持项目变得更加困难。 为您的文档和代码使用相同的版本控制工具。 您的文档的所有版本均应与源代码的版本相匹配,否则我们将无法信任文档。 文档生成器应允许您使用不同的文件类型来编写文档,例如源代码文件(Rust,C ++,TypeScript,Java,JavaScript,Ruby,Python等),规范文件(合金,TLA +等),样式表文件(CSS, SCSS,QT样式表等),配置(JSON,TOML,YAML等)。 为什么要使用它 如果要使文档与代码保持同步,并希望在实现功能的地方描述业务功能的不同部分,则可以在


【文件预览】:
fundoc-master
----.travis.yml(2KB)
----book.toml(178B)
----images()
--------fundoc-work.png(109KB)
--------full-text-search.gif(4.45MB)
--------fundoc-init.png(194KB)
--------fundoc-example.png(23KB)
--------logo.png(43KB)
----.grenrc(189B)
----docs()
--------css()
--------highlight.css(1KB)
--------.nojekyll(72B)
--------tomorrow-night.css(2KB)
--------favicon.png(6KB)
--------highlight.js(132KB)
--------searcher.js(18KB)
--------configuration.html(12KB)
--------404.html(9KB)
--------mark.min.js(17KB)
--------print.html(12KB)
--------FontAwesome()
--------syntax.html(10KB)
--------ayu-highlight.css(947B)
--------favicon.svg(2KB)
--------fonts()
--------elasticlunr.min.js(18KB)
--------index.html(12KB)
--------searchindex.js(28KB)
--------book.js(24KB)
--------searchindex.json(28KB)
--------clipboard.min.js(11KB)
----Cargo.lock(46KB)
----.github()
--------workflows()
----docs_src()
--------configuration.md(2KB)
--------syntax.md(572B)
--------SUMMARY.md(73B)
----ci()
--------before_deploy.sh(629B)
--------install.sh(1KB)
--------script.sh(444B)
--------before_deploy.ps1(588B)
----LICENSE(1KB)
----src()
--------main.rs(1KB)
--------cli.rs(456B)
--------config.rs(5KB)
--------book.rs(666B)
--------generator.rs(3KB)
--------parser.rs(13KB)
----Cargo.toml(675B)
----.gitignore(7B)
----fundoc.json(332B)
----README.md(5KB)
----.editorconfig(195B)

网友评论