Laravel API 文档太简陋了

基本全是一句话描述。参数还好说,函数的返回值没有一点描述,更别说注意事项、相关链接了。
比如 Illuminate\Database\Eloquent\Builder 中 delete 返回值只说是一个整数。这个整数表示什么意思呢?
难道大家都靠研究源代码么?

本作品采用《CC 协议》,转载必须注明作者和本文链接
一亩三分地儿
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《G01 Go 实战入门》
从零开始带你一步步开发一个 Go 博客项目,让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。
讨论数量: 13
codejam

请看官方文档

5年前 评论
JaguarJack

对,文档很简陋。你有时候只能去翻源码

5年前 评论

个人觉得 Laravel 的文档写的非常人性化,而不是死板的列出方法名、参数名。通过文档了解思想,再阅读源码和 PHPDoc,获得更多深层次的用法。如果你的代码阅读能力不强,建议看 TP。虽然我觉得 TP 的文档也不咋地,不严谨。

5年前 评论
一亩三分地儿

@Wi1dcard 兄弟 用人性化比喻API文档有点夸张了。你看一下微软C#的文档,基本都还有示例代码,相关的主题,还有能跑起来的演练项目,只是那帮翻译人经常把不需要翻译的关键字也给翻译了。PHP官方的文档也不错。

5年前 评论

我说的是 Laravel 的文档,而非 API 参考。Laravel 的文档不是为了让你理解某个方法的具体用途、代码逻辑,而是更倾向于介绍框架设计的思想,为你接下来的探索引路。我觉得这是其他文档所做不到的,MSDN 我之前也有看过,的确每个方法、每个参数都写得很详细,但是我个人感觉还是不如 Laravel 的文档更贴近于「人」。

或者这么说吧,Laravel 的文档我能在一天内看完并开始写一个小项目,项目中常见的所需,都能在脑子里有印象、有思路,知道该用何种方式、哪个组件,而 PHP 或者 MSDN,我只能把他们当作一个 API 参考,有了思路,才能去查的参考。
@一亩三分地儿

5年前 评论

我猜 Laravel 文档在作者编写时的初衷,就是为了让人能快速阅读完、有一个整体的思路和方向,而不是列一大堆 API 参考。想想曾经我也是微软粉,后来深入思考觉得... Laravel 火起来,的确是有原因的。

5年前 评论

真香

5年前 评论
一亩三分地儿

@Wi1dcard 你说的没错,官网文档及翻译都做的非常好,很轻松就入门了。但深挖的时候就靠猜和不断试验了,刚接触,看源码好费劲。

5年前 评论

MSDN 和 MDN 的文档是我见过做的最好的
Laravel 的文档只能用简陋来形容
(非 API 文档

5年前 评论

确实laravel文档写得不够详细,很多用法都没有列举。
但是,正如@Wi1dcard 所说,laravel文档还是比较全面的,每个知识点都有提及。
想要深入运用,没办法,只能硬看源码。耗费了不少时间,但是耗费时间的同时,自己也会有很大提升。

5年前 评论
laravel文档写得不够详细,很多用法都没有列举

+1

5年前 评论

探索,发现,嘿嘿

5年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!