Comments (1)
JSON 和 INI 对于富文本并不合适,虽然 apidoc 基本上用不到富文本,但是提供了该功能;
YAML 嵌在大段的注释中,很容易出现缩进不统一的情况;
INI、TOML、JSON 和 YAML 并没有属性的概念,每一个值必须得一行,会造成注释代码过于冗长;
而且部分代码风格会限制每一行的长度,JSON 和 YAML 在嵌套比较深的情况下,每一行写不了几个字。而在不缩进的情况下,XML 的可读性是最好的。
from apidoc.
Related Issues (20)
- 有没编译好的可以直接下载的 HOT 1
- 能否提供指定编码选项
- 代码高亮依赖资源 404 HOT 1
- 生成doc的时候是否支持例外 HOT 2
- 支持 openapi 格式的输出
- PHP 支持 herodoc 和 nowdoc
- apiParam添加来源和是否必须参数 HOT 1
- 需要将字符类型的值,也当作字符串处理
- 支持 raml 的导出
- 文档不能查看么?运行失败 HOT 4
- https://apidoc.tools 网站 访问不了,可否给出详细的使用用例呢? HOT 3
- 找不到结束符号 HOT 6
- 通过 channel 接收所有的语法错误信息
- 去掉示例代码的行首空格
- 能否支持json格式呢? HOT 2
- 生成的index.html内容为空
- 添加 LSP
- 提供demo頁面 HOT 3
- 如何使 apidoc 是支持 二方依赖包裹的 接口描述 配置 ? HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from apidoc.