1

我在注释中继承了一些带有 doxygen 注释的 C 源代码。由于位腐烂，一些注释的\return注释现在是谎言，即一个函数已被转换为返回 void，但\return注释仍然存在并另有说明。

例子：

/*!
 * \brief   The foo function
 * \return  OK if successful, ERROR otherwise
 */
void foo(void)
{
    ...
}

现在我想找到所有这样的文件。我想过使用 grep/sed/awk/perl 来查找\return然后打印以 . 开头的下一行void。一个简单的

 grep -E '(\\return|^void)' file ...

还打印\return来自非空函数的所有注释。我确信有一种简单的方法可以仅在看到一行时打印前\return一行^void。

4

2 回答 2

2

如果您的所有函数及其前面的评论都遵循您发布的样式，这可能就是您所需要的：

awk '/\\return/{cmt=$0} /^[[:alpha:]]/{ if (/^void/ && cmt) print cmt ORS $0; cmt=""}' file

例如：

$ cat file
/*!
 * \brief   The foo function
 * \return  OK if successful, ERROR otherwise
 */
void foo(void)
{
    ...
}

/*!
 * \brief   The bar function
 * \return  OK if successful, ERROR otherwise
 */
int bar(void)
{
    ...
}

$ awk '/\\return/{cmt=$0} /^[[:alpha:]]/{ if (/^void/ && cmt) print cmt ORS $0; cmt=""}' file
 * \return  OK if successful, ERROR otherwise
void foo(void)
于 2013-08-27T15:33:17.800 回答
1 
#! /usr/bin/env perl

use strict;
use warnings;

my $prev_return;

while (<>) {
  # assume letter in first column introduces a function return type
  if (my($return_type) = /^([^\W\d]\w*)/) {
    if ($return_type eq "void" && defined $prev_return) {
      print $prev_return;
    }
    undef $prev_return;  # reset after each function definition
  }
  elsif (/\\return\b/) {
    $prev_return = "$ARGV:$.: $_";
  }
}
continue {
  close ARGV if eof;  # reset $. at the end of each named file
}

注意：该模式[^\W\d]使用双重否定技术来匹配不是数字的“单词字符”，即字母和下划线。

样本输出：

$猫文件.c
/*！
 * \brief foo 函数
 * \成功则返回OK，否则返回ERROR
 */
无效富（无效）
{
    ...
}

\return fdsklj
空栏（空）

无效的巴兹

$ ./doxygen-return-void 文件.c
file.c:3: * \如果成功则返回 OK，否则返回 ERROR
file.c:10: \return fdsklj

Perl 的<>，也称为菱形运算符，使编写 Unix 风格的过滤器变得容易。这意味着您可以根据需要命名任意数量的路径。

$ ./doxygen-return-void file.c file.c
file.c:3: * \如果成功则返回 OK，否则返回 ERROR
file.c:10: \return fdsklj
file.c:3: * \如果成功则返回 OK，否则返回 ERROR
file.c:10: \return fdsklj

上面的程序也会消耗标准输入，但输出并不是非常有用。

$ 猫文件.c | ./doxygen-return-void
-:3: * \如果成功则返回OK，否则返回ERROR
-:10: \return fdsklj
于 2013-08-27T18:51:50.400 回答