api文档怎么写? api接口我已经写好了但时文档不太会写 还有编写api文档有啥作用 请各位高手大虾指点迷津

Posted 2023-03-16

php的api接口的文档！！~~~ 就是用word写的客户端参数说明：

m【*】 act【*】
top ascPrice/ascByCPrice/descPric/descByCPrice
注：其中ascPrice为按涨额排序ascByCPrice为按涨幅排序descPrice为按降额排序descByCPrice为按降幅排序
客户端调用方式
http://lig.cn/api/iphone.m?m=top&act=ascPrice
返回：
类似于这种方式

很多扩展类，框架。PHP有第三方的函数库。DELPHI则是控件。其实这体现了“软件工程”中代码重用的思想。任何好的，工业生产级别的语言都会有很多的扩展支持的。如果，每个体统都需要从底层一点一点的敲代码。是很浪费的。DELPHI整个体系的思想是很优秀的。被很多语言工具借鉴。比如.NET。而且DELPHI是开源的。这些控件，都是优秀的学习资料。 祝你好运 参考技术A lz，你指的是JavaDoc么？
如果你是用eclipse，可以在java类或java包上右键，选择export --> 选择javadoc，直接finish即可。
至于javadoc的规范，请参阅文库中的详细文档或百科：
http://baike.baidu.com/view/975838.htm