Replies: 2 comments
-
我觉得 doxygen 最有价值的部分在于,不需要额外写文档、画各种各样的图表、写 API 的说明,它能直接通过代码中的注释信息生成对应的文档和类图、调用图等等信息 这样一方面节省了很多功夫,只需要专注于代码的编写(以及在写代码的时候顺手写一下注释);另外一方面避免了代码和文档的不一致性,比如说修改了某个变量名称或某个函数名,它立刻就会在文档里面反映出来 对于 eBPF 程序我觉得也可以是类似的思路,绝大多数的需求可以只写内核态程序,并且在写内核态程序的时候顺手写一些注释就行,不必去关注用户态程序的编写 另外一方面这样也可以确保内核态程序和用户态的部分是一致的,不存在某些因为内核态修改了而用户态忘了修改带来的 bug,也能减少一些负担;用户态程序可以完全不写,也可以只写最关键的数据处理逻辑,不需要关注于怎么 attach 函数之类的事情 |
Beta Was this translation helpful? Give feedback.
0 replies
-
add in 0.3.0. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
下一步的初步想法是想用这样的方式去在内核态 eBPF 程序里面声明一个 attach,比如说 uprobe 或者 xdp
类似这样,不知道大家有没有什么建议或者意见....
灵感来源是 doxygen,rust 的 ebpf 框架 aya-rs,或者说更通用的注解,目标是让只写内核态代码的情况下也能完成尽可能完整的 eBPF 程序的功能开发
或者这样?
又或者这样?
这些注释可能可以被直接转化为 JSON-RPC,然后在运行的时候去调用对应函数启动
/zh.m.wikipedia.org/zh-hans/JSON-RPC
(应该和 doxygen 完全兼容?)
https://tsdoc.org/pages/spec/tag_kinds/
其他语言比如说 ts 和 js 也有类似的语法.....不过我不太确定哪种写法会比较好
Beta Was this translation helpful? Give feedback.
All reactions