为textx自动生成dsl文档

textx-dsldoc的Python项目详细描述


#textx dsl自动文档工具 一个旨在自动生成dsl文档的非官方textx poc项目。

为了测试textx集成,您将需要安装[从存储库](https://github.com/textX/textX),因为cli扩展在1.8中不可用。

##文件

  • [example.py](example.py):直接取自[另一个项目](https://github.com/aluriak/24h2019)的dsl定义示例
  • [out.html](out.html):html输出文件(查看以了解当前项目的成就)
  • [poc.py](poc.py):第一个实现,非常糟糕,但是很少有函数值得保存
  • [poc_as_cls.py](poc_as_cls.py):使用poc.py的一些函数来实现相同的功能,但方式要更清楚一些
  • [poc_render_peg.py](poc_render_peg.py):arpeggio(textx backend)语法的呈现

[当前结果](out.html)令人鼓舞。

##f(unny)功能

  • 支持docstring(用户类级别的文档)
  • 为正则表达式自动生成示例,并完全链接到[pythex.org](https://pythex.org

##待办事项

  • 集成完整示例(随机或作者提供)
  • 获取一个包含高级功能(如引用和其他textx/arpeggio结构)的完整示例
  • 为规则的描述修复终端的检测和处理
  • 为每个文档化规则生成几个示例(可能是随机的)
  • 使生成具有确定性
  • 使短语更人性化(例如:当仅对原始字符串进行选择时,请避免使用项目符号列表,并将它们与最后一个连接的直接列在一起:类型可以是a、b、e)
  • 使用[textx子命令](https://github.com/textX/textX/pull/162)集成到textx中(请参见[doc](http://textx.github.io/textX/latest/textx_command/#extending-textx-command))

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java未从Facebook OAuth接收名字、姓氏和姓氏   我自己代码中的java ConcurrentModificationException   java在Android上获得单像素TIFF图像   java图形输出中的swing集成弹出窗口“通知”   将数据库表中的所有数据集插入jTable Java   java如何使用Hibernate获取不完整的集合?   打印无法从java连接到打印机   java使用分隔符拆分带引号的字符串   java Axis2禁用严格验证(wsdl2java中的Eosv)允许什么,如何使其更加严格?   java有人能帮我处理循环代码吗   java将JsonObject数组转换为整数   JavaXWiki扩展:检测事件空间创建   java如何设置图表的文本方向以使用poi旋转所有文本?   eche RecyclerView项的java Set自定义字体   java单元测试带有私有构造函数的spring组件,无需注入   用户界面如何在java中动态显示一组多个元素?   如何从java应用程序调用IDL(交互式数据语言)?   Java的内置库实现