ricq icon indicating copy to clipboard operation
ricq copied to clipboard

[Question] 没有使用文档吗

Open lomirus opened this issue 3 years ago • 6 comments

看了下代码也基本没有注释,cargo doc 生成的文档可读性也比较差...

lomirus avatar Feb 04 '22 11:02 lomirus

另外也建议完善下仓库的 About,感觉写的格式太随便了,而且内容重合度和 README 太高,貌似还有些过时()

lomirus avatar Feb 04 '22 11:02 lomirus

可能吐槽的有点多了,抱歉哈😂

还有不少地方,比如下面这张图里,暴露的模块、命名上感觉也比较凌乱

lomirus avatar Feb 04 '22 12:02 lomirus

看了下代码也基本没有注释,cargo doc 生成的文档可读性也比较差...

现在确实还没写文档,还在快速迭代的阶段,目前所有模块都是 pub 的,实际上 pb 模块应该是私有的。(可以提交PR一起写)

如果需要基于 Rust 开发,可以用 rq-tower,里面有 examples。

lz1998 avatar Feb 04 '22 15:02 lz1998

可能吐槽的有点多了,抱歉哈😂

还有不少地方,比如下面这张图里,暴露的模块、命名上感觉也比较凌乱

现在已经把一些不必要的模块设置成了私有,注释文档目前只有API部分,其他的暂时还没写

lz1998 avatar Feb 05 '22 05:02 lz1998

请问如果日后要完善doc的话,您更倾向英文还是中文呢?@lz1998

Itsusinn avatar Jun 26 '22 05:06 Itsusinn

好多函数还是没有介绍文档啊。。。 以及范例的注释也比较少,还会日后完善吗》

starrys147 avatar Sep 27 '22 16:09 starrys147