敝帚自珍: 库易用性的自我观察

去年5月份, 我在codeproject上发布了我的第一版在C++中模拟.NET中对Enum类型的reflection操作, 自以为得意, 也在实际项目中使用(其实动机就是实际项目中有需要).

现今, 我再次审视自己的这个小小作品, (前提是, 这段时间我自己没再用它.) 却自己发现原来的设计还是给了实用者太多的负担.

一个人潜心在一件事情上, 相对短的一小段时间内, 脑子中会对与此事相关的方方面面比较熟悉, 以至于对自己在当初设计出的使用接口, 根本无法从一个局外人的角度来评价它的易用性.

这两天, 花了很多时间反复琢磨和测试C++模板和宏, 改进了易用性. 但是, 总结一下, 还是会给使用者带来以来的成本:

1. 得记住 #include "Reflection4CppEnum.hpp"

2. 得记住以下宏的名字和要求的形式:

   ENUM_ITEM(x, y, Enum_Entry)

   ENUM_ITEM_VALUE(x, y, Enum_Entry, 12)

   DEF_ENUM(namespace::class,  WeekDay, ALL_THE_WEEK);

3. 如果枚举是定义在名字空间/类的内部, 还需要分别使用

    DEF_ENUM_1(namespace::class, WeekDay, ALL_THE_WEEK);  来定义

    DEF_ENUM_2(namespace::class, WeekDay, ALL_THE_WEEK);  来实例化模板类.

4. 得记住ALL_THE_WEEK的固定的形式:

   #define ALL_THE_WEEK(x, y) \

           ENUM_ITEM(x, y, Sunday)   \

           ENUM_ITEM_VALUE(x, y, Tuesday, 5)

   

5. 得理解在文件范围内使用 DEF_ENUM时, 第一个参数为什么要空着.

   

6. 对好奇心重的人, 可能会被这种以变量风格使用函数风格的宏的做法感到疑惑. 进而去看其定义的细节.

7. 得了解EnumHelper<>:: 定义的一系列API

   to_string, index_of, parse, count, 等

8. 万一用错了, 编译器给出的信息可是很可能会误导的, 而这个库的实现并没有从出错信息的角度进行过考虑.