我试图在 C++项目的 README 内写明项目特性。
实际上,我只需要把.cpp 文件内的注释搬运到 README 内,就几乎可以解决问题。
但我找不到(或者不知道)提取注释的工具。
具体来说,我希望能从如下的代码:
/*
指出函数特性的注释
*/
int process(const char* str)
{
xxxxxxx
//只有当满足某个条件,才能为真
if( func(A) == true )
{
xxxxxxx
}
}
提取出这样的信息:
/*
指出函数特性的注释
*/
int process(const char* str)
//只有当满足某个条件,才能为真
if( func(A) == true )
我找不到现成的工具,因此只能自己写了一个小工具,勉强满足了自己的需求。
但我仍然好奇:
有无更简单直接的方法提取出.cpp 文件中的注释,以便于 README 的撰写呢?
我的工作环境是 unix + vscode (有时候是 vim )
|