【为 RT-Thread 添砖加瓦】编程指南阅读笔记、排版错误记录以及下一版的建议~~~

STM32_Study · 发表于 2010-4-4 22:59:42

首先说说几个PDF排版上的问题

第一个之前提过，就是现在这个版本的编程指南，GUI后面的几个标签无效
第二个是，对里面的内容进行复制，下划线会丢失，这个估计是生成软件的问题。
第三个是，建议ffxz使用无衬线的字体作为代码的字体，譬如fixedsys之类的，特别是字体比较小时，这样阅读起来比较轻松

刚好是放假，这两天花了一些时间阅读编程指南，做了一些阅读笔记，用注释的方式附加在了PDF文件上，我上传上来。
我是从一个初学者读者的角度去看，所提出的问题可能有些浅薄，希望能对RT-Thread有帮助~~
目前我阅读到了线程之间的同步和通信。内存管理和后面的部分还没有看

GUI部分我看了一下，发现了两个笔误，我框出来了~~~

点击此处下载 ourdev_543722.pdf(文件大小:2.58M) (原文件名:RT-Thread030.pdf)

再说说，我觉得RT-Thread手册还应该加强的部分

第一个是，同类型、相似的元素，应该对异同点加以说明比较，最好是辅以图表。譬如邮箱、消息队列、事件等，这是属于同一性质的元素，可以对这些进行比较异同点。对不同的应用场合加以提点。

第二点是，使用的代码尽可能跟现发布的同版本的代码一致。建议在现有svn版本的BSP目录下面，增加一个跟编程指南对应的目录。里面就是针对书里的每一个讲解范例的源代码。

第三点是，对GUI部分，需要大大加强。现在这个版本的编程指南，对GUI部分的解说实在是太简略了。甚至基本的函数说明都没有提到~~

第四点是，ffxz在编程指南里曾经提到艰难的发展期：“在第一个公开板发布后（0.1），RT-Thread意识到了一个问题，光有核心不行。别人如何使用：虽
然采用了doxygen风格的注释，并自动产生相应的API文档(且是英文的)，但能够使用的人寥寥，有这个功底的人不见得认可你的系统，没相应功底的人也玩不转你的系统。”

从这一点上来说，RT-Thread的编程指南，非常有必要对嵌入式实时系统的一些基本概念和RT-Thread专有的一些概念进行解析。这样才能吸引更多的初学者来学习。因为初学者往往是为了兴趣爱好和技术提升来学习的，他们不存在转阵营的痛苦。在初学者带动起RT-Thread社区的氛围以后，才能慢慢吸引那些有功底的人来关注和转变阵营。

这里我凭印象提一个，GUI里面 Panel 的概念基本没有提到，如何应用也没有详细说明。

希望以上的一些想法，能对RT-Thread有帮助~~~

ffxz · 发表于 2010-4-5 08:35:56

多谢多谢！

问一下，你在其中加了红框的是什么意思？

排版上目前还没什么有效的办法（特别是字体，表格超出正常页宽），我逐步更改到LaTex格式进行排版吧。看了你对一些例程也圈出了红框，这个请先阅读后面的附录章节，里面对例程特殊部分有专门的提及。关于RT-Thread中的特殊概念，还请楼主多提出来，同时您认为文中对你依然还是模糊的部分也请提出来。再次感谢楼主的建议。

luxinsun · 发表于 2010-4-5 10:02:24

好啊，尽快修订好。我推迟打印了。

luxinsun · 发表于 2010-4-5 10:19:21

顺便给RTT的源码提一个初学者的建议。还请指正。
一个C文件对应一个H文件。需要在其他C文件中调用的函数写在H文件中。不喜欢下面的这种声明方式。

(原文件名:1.jpg)

aozima · 发表于 2010-4-5 10:28:36

"一个C文件对应一个H文件" 里面不也得这么写嘛?

"一个C文件对应一个H文件"后,文件数量成倍增加.你认为是好事还是坏事?
现在只需要 rtthread.h 一个就行了.里面包括了所有.

STM32_Study · 发表于 2010-4-5 10:29:59

回复【1楼】ffxz
多谢多谢！
问一下，你在其中加了红框的是什么意思？
排版上目前还没什么有效的办法（特别是字体，表格超出正常页宽），我逐步更改到LaTex格式进行排版吧。看了你对一些例程也圈出了红框，这个请先阅读后面的附录章节，里面对例程特殊部分有专门的提及。关于RT-Thread中的特殊概念，还请楼主多提出来，同时您认为文中对你依然还是模糊的部分也请提出来。再次感谢楼主的建议。
-----------------------------------------------------------------------

红框的问题，那我重新做一下注释吧 ^_^

表格排版，我是想说增加行线，把行与行之间区分开来
其他的，慢慢改善吧

例程的，我现在才看到“线程之间的同步和通信”，后面的还没有看到，所以提到了这个疑问。刚刚去看了一下，基本明白了，是构建一个小型测试系统的意思~~其实之前也能猜到是这个意思。只是从严谨的角度来建议，我觉得这个部分应该放在前面比较合适。

重新上传，去掉了一些已经理解的和一些无关紧要的。其他的都增加了注释

点击此处下载 ourdev_543779.pdf(文件大小:2.61M) (原文件名:RT-Thread030.pdf)

aozima · 发表于 2010-4-5 10:39:01

楼上看得很仔细,学习 :-)

有什么快速的方法可以直接跳到每个标注?

STM32_Study · 发表于 2010-4-5 10:41:19

就RT-Thread概念的问题

我想，同类型的都应该拿来对比异同点，解释一下

譬如我在注释里面也提到的，线程切换函数的问题，我就有疑问，两个函数的异同点和使用限制没搞明白

此外，对线程之间的轮片和切换，P40 的那个图太简略了，对概念无法解释清楚

建议增加一些图，对于线程间轮片或切换的流程讲仔细一些。譬如结合P35内核对象的那个图，画一个实际系统运转的流程

STM32_Study · 发表于 2010-4-5 10:43:31

回复【6楼】aozima
楼上看得很仔细,学习 :-)
有什么快速的方法可以直接跳到每个标注?
-----------------------------------------------------------------------

按菜单“注释”--“显示注释列表”

ffxz · 发表于 2010-4-5 12:04:22

回复【3楼】luxinsun
顺便给RTT的源码提一个初学者的建议。还请指正。
一个C文件对应一个H文件。需要在其他C文件中调用的函数写在H文件中。不喜欢下面的这种声明方式。

(原文件名:1.jpg)

-----------------------------------------------------------------------

通常，需要提供给外部用户使用的函数会放在头文件中进行统一声明，而内部使用的函数有几种方式：
1. 一个文件内，采用static的方式仅局限于一个文件中并做一定的隐藏。
2. 对于多个文件使用，可以新做一个头文件，例如xx_internal.h，然后在上面做声明。
3. 对于多个文件使用，也可以在使用到的文件中做extern声明。

RT-Thread在多个文件内方面，使用了第3点。

cat_li · 发表于 2010-4-6 09:12:52

能讲的详细一点吗，关于多文件使用，看的不是很明白

yangskyhigh · 发表于 2010-4-8 08:48:59

回复【9楼】ffxz
-----------------------------------------------------------------------

3楼的建议可能是想采用第2种方式，这种方式的一个缺点是，如果某个头文件做了修改的话，那么所有申明包含此头文件的.c程序都会被keil重新编译；

如果很不幸你使用zlg的那种方法：一个config.h 包含所有的.h文件，而所有的.c文件又包含 config.h……那么你改了某个.h文件的话，就等着重新编译整个工程吧----我就是这样痛苦的人，现在工程大了，改一个.h文件就苦等……

zhenhuah · 发表于 2010-5-27 19:43:05

mark

zhenhuah · 发表于 2010-5-27 19:44:30

下不了

【为 RT-Thread 添砖加瓦】编程指南阅读笔记、排版错误记录以及下一版的建议~~~

阿莫论坛20周年了！感谢大家的支持与爱护！！

浏览过的版块