AskOverflow.Dev

AskOverflow.Dev Logo AskOverflow.Dev Logo

AskOverflow.Dev Navigation

  • Início
  • system&network
  • Ubuntu
  • Unix
  • DBA
  • Computer
  • Coding
  • LangChain

Mobile menu

Close
  • Início
  • system&network
    • Recentes
    • Highest score
    • tags
  • Ubuntu
    • Recentes
    • Highest score
    • tags
  • Unix
    • Recentes
    • tags
  • DBA
    • Recentes
    • tags
  • Computer
    • Recentes
    • tags
  • Coding
    • Recentes
    • tags
Início / unix / Perguntas / 766179
Accepted
jwzumwalt
jwzumwalt
Asked: 2024-01-05 13:21:40 +0800 CST2024-01-05 13:21:40 +0800 CST 2024-01-05 13:21:40 +0800 CST

Imprima todos os comentários C em um arquivo de texto separado

  • 772

Gostaria de imprimir todos os meus comentários C em um arquivo de texto separado.

  • Usando awk, sed, grep ou bash
  • gerar todos os comentários C multilinhas entre /* ... */ (inclusive)
  • linhas de saída com // comentários
  • Opcional: imprimir números de linha

Eu tentei essas soluções, mas não funcionou no Ubuntu

  • Analisando comentário multilinha do estilo C
  • https://stackoverflow.com/questions/57723357/how-can-i-grep-matching-a-comment-string

O objetivo da minha solicitação é poder usar rapidamente os comentários do código-fonte como ponto de partida para uma boa documentação. Eu não gosto da confusão extra e dos comandos incorporados proprietários (ou seja, Doxygen) de programas de documentação dedicados. Por exemplo, comentar adequadamente cada função do código-fonte e remover comentários superficiais de uma linha economizará muito tempo e fornecerá uma referência quase completa. Isso também incentivará melhores comentários no código-fonte.

c
  • 4 4 respostas
  • 1301 Views

4 respostas

  • Voted
  1. Opifex
    2024-01-05T22:01:29+08:002024-01-05T22:01:29+08:00

    Já houve algumas respostas usando shell-magic, mas acho que isso pode ser feito muito mais facilmente usando as ferramentas que você provavelmente já possui. Ou seja, gcc.

    diff -u <(gcc -fpreprocessed -dD -E main.c) main.c | grep '^+' | cut -c 2-

    Como funciona?

    1. gcc -fpreprocessed -dD -E main.c Remove todos os comentários de um arquivo e o coloca em stdout

    2. diff -u <(...) main.c Pega a entrada do stdout e compara com o original

    3. grep '^+' Filtra todas as linhas que começam com +. Em outras palavras: filtrar o que antes era um comentário determinado

    4. cut -c 2- Remova os +símbolos da saída

    Não há necessidade de coisas supercomplexas de regex, perl ou awk, ao mesmo tempo que cobre todos os casos extremos que as outras respostas podem ter perdido.

    • 26
  2. Stéphane Chazelas
    2024-01-05T16:16:20+08:002024-01-05T16:16:20+08:00

    Não é tão trivial quanto pode parecer se você levar em conta coisas como: puts("string with /*")ter em mente que "s pode ocorrer em ch = '"'.

    Ou continuações de linha:

    printf("...");    /\
    * yes, this is a comment */
    /\
    / and this as well
    

    Ou trígrafos .

    Para cobrir isso, podemos adaptar esta resposta à pergunta oposta para imprimi-la em vez de remover os comentários:

    perl -0777 -pe '
      s{
        (?<comment>
          # /* ... */ C comments
          / (?<lc> # line continuation
              (?<bs> # backslash in its regular or trigraph form
                \\ | \?\?/
              )
              (?: \n | \r\n?) # handling LF, CR and CRLF line delimiters
            )* \* .*? \* (?&lc)* /
          | / (?&lc)* / (?:(?&lc) | [^\r\n])* # // C++/C99 comments
        ) |
           "(?:(?&bs)(?&lc)*.|.)*?" # "strings" literals
           | '\''(?&lc)*(?:(?&bs)(?&lc)*(?:\?\?.|.))?(?:\?\?.|.)*?'\'' # (w)char literals
           | \?\?'\'' # trigraph form of ^
           | .[^'\''"/?]* # anything else
      }{$+{comment} eq "" ? "" : "$+{comment}\n"}exsg'
    

    Quais são os exemplos inventados da outra questão que cobrem a maioria dos casos extremos:

    #include <stdio.h>
    int main()
    {
      printf("%d %s %s %c%c%c%c%c %s %s %d\n",
      1-/* comment */-1,
      /\
    * comment */
      "/* not a comment */",
      /* multiline
      comment */
      // comment
      /\
    / comment
      // multiline\
    comment
      "// not a comment",
      '"' /* comment */ , '"',
      '\'','"'/* comment */,
      '\
    \
    "', /* comment */
      "\\
    " /* not a comment */ ",
      "??/" /* not a comment */ ",
      '??''+'"' /* "comment" */);
      return 0;
    }
    

    Dá:

    /* comment */
    /\
    * comment */
    /* multiline
      comment */
    // comment
    /\
    / comment
    // multiline\
    comment
    /* comment */
    /* comment */
    /* comment */
    /* "comment" */
    

    Para obter os números das linhas, como estamos executando no modo slurp, onde o assunto é toda a entrada, em vez de processar a entrada uma linha por vez, é um pouco mais complicado. Poderíamos fazer isso usando o (?{code})operador regexp para incrementar um contador cada vez que um delimitador de linha (CR, LF ou CRLF em C) for encontrado:

    perl -0777 -pe '
      s{
        (?<comment>(?{$l=$n+1})
          /
          (?<lc>  # line continuation
            (?<bs> # backslash in its regular or trigraph form
              \\ | \?\?/
            ) (?<nl>(?:\n|\r\n?) (?{$n++})) # handling LF, CR and CRLF line delimiters
          )*
          (?:
            \* (?: (?&nl) | .)*? \* (?&lc)* / # /* ... */ C comments
            | / (?:(?&lc) | [^\r\n])*         # // C++/C99 comments
          )
        ) |
           "(?:(?&bs)(?&lc)*.|.)*?" # "strings" literals
           | '\''(?&lc)*(?:(?&bs)(?&lc)*(?:\?\?.|.))?(?:\?\?.|.)*?'\'' # (w)char literals
           | \?\?'\'' # trigraph form of ^
           | (?&nl)
           | .[^'\''"/?\r\n]* # anything else
      }{$+{comment} eq "" ? "" : sprintf("%5d %s\n", $l, $+{comment})}exsg'
    

    O que nessa mesma amostra dá:

        5 /* comment */
        6 /\
    * comment */
        9 /* multiline
      comment */
       11 // comment
       12 /\
    / comment
       14 // multiline\
    comment
       17 /* comment */
       18 /* comment */
       21 /* comment */
       26 /* "comment" */
    
    • 13
  3. Best Answer
    td211
    2024-01-05T14:19:19+08:002024-01-05T14:19:19+08:00

    Isso pode ser feito da awkseguinte forma:

    #!/bin/awk
    
    # Handles case where both /* and */ are on the same line
    { line_printed = 0; }
    
    # Find the beginning of a multiline comment
    /^[[:space:]]*\/\*/ {
        multiline = 1;
    
        # Remove leading spaces
        sub(/^[[:space:]]+/,"");
        printf "[%d] %s\n", NR, $0;
        line_printed = 1;
    }
    
    # Find the end of a multiline comment
    /\*\/[[:space:]]*$/ {
        multiline = 0;
        if (line_printed == 0)
            printf "%s", $0;
    
        print "\n"
        next;
    }
    
    # The content between /* and */
    {
        if ( multiline == 1 && line_printed == 0 )
        {
            print $0;
            next
        }
    }
    
    # A single line comment
    /^[[:space:]]*\/\// {
        # Remove leading spaces
        sub(/^[[:space:]]+/,"");
        printf "[%d] %s\n\n", NR, $0;
    }
    

    Salve este script como foo.awk(ou qualquer outro nome; a extensão é opcional) e execute com awk -f foo.awk input.c. O script imprimirá todos os comentários (separados por uma nova linha extra) e adicionará o número da linha antes de cada comentário.

    • 2
  4. Bog
    2024-01-05T15:56:24+08:002024-01-05T15:56:24+08:00

    Bem, definitivamente não é o mais sofisticado, nem o mais recomendado, porque tem algumas falhas. Mas acho que fica muito legal:

    awk '/\/\//; /\/\*.*\*\//; /\*\//; /^\/\*/ { a=1 } /\*\// { a=0 } a && $0 != "/*" { print }'
    
    • 2

relate perguntas

  • Obter saída somente hexadecimal do objdump

  • Leia /proc/pid/maps usando read()

  • Quando o heap é usado para alocação dinâmica de memória?

  • O que exatamente o GNU faz dep faz?

  • Otimização de programas baseados em OpenCV sistema operacional linux incorporado [fechado]

Sidebar

Stats

  • Perguntas 205573
  • respostas 270741
  • best respostas 135370
  • utilizador 68524
  • Highest score
  • respostas
  • Marko Smith

    Possível firmware ausente /lib/firmware/i915/* para o módulo i915

    • 3 respostas
  • Marko Smith

    Falha ao buscar o repositório de backports jessie

    • 4 respostas
  • Marko Smith

    Como exportar uma chave privada GPG e uma chave pública para um arquivo

    • 4 respostas
  • Marko Smith

    Como podemos executar um comando armazenado em uma variável?

    • 5 respostas
  • Marko Smith

    Como configurar o systemd-resolved e o systemd-networkd para usar o servidor DNS local para resolver domínios locais e o servidor DNS remoto para domínios remotos?

    • 3 respostas
  • Marko Smith

    apt-get update error no Kali Linux após a atualização do dist [duplicado]

    • 2 respostas
  • Marko Smith

    Como ver as últimas linhas x do log de serviço systemctl

    • 5 respostas
  • Marko Smith

    Nano - pule para o final do arquivo

    • 8 respostas
  • Marko Smith

    erro grub: você precisa carregar o kernel primeiro

    • 4 respostas
  • Marko Smith

    Como baixar o pacote não instalá-lo com o comando apt-get?

    • 7 respostas
  • Martin Hope
    user12345 Falha ao buscar o repositório de backports jessie 2019-03-27 04:39:28 +0800 CST
  • Martin Hope
    Carl Por que a maioria dos exemplos do systemd contém WantedBy=multi-user.target? 2019-03-15 11:49:25 +0800 CST
  • Martin Hope
    rocky Como exportar uma chave privada GPG e uma chave pública para um arquivo 2018-11-16 05:36:15 +0800 CST
  • Martin Hope
    Evan Carroll status systemctl mostra: "Estado: degradado" 2018-06-03 18:48:17 +0800 CST
  • Martin Hope
    Tim Como podemos executar um comando armazenado em uma variável? 2018-05-21 04:46:29 +0800 CST
  • Martin Hope
    Ankur S Por que /dev/null é um arquivo? Por que sua função não é implementada como um programa simples? 2018-04-17 07:28:04 +0800 CST
  • Martin Hope
    user3191334 Como ver as últimas linhas x do log de serviço systemctl 2018-02-07 00:14:16 +0800 CST
  • Martin Hope
    Marko Pacak Nano - pule para o final do arquivo 2018-02-01 01:53:03 +0800 CST
  • Martin Hope
    Kidburla Por que verdadeiro e falso são tão grandes? 2018-01-26 12:14:47 +0800 CST
  • Martin Hope
    Christos Baziotis Substitua a string em um arquivo de texto enorme (70 GB), uma linha 2017-12-30 06:58:33 +0800 CST

Hot tag

linux bash debian shell-script text-processing ubuntu centos shell awk ssh

Explore

  • Início
  • Perguntas
    • Recentes
    • Highest score
  • tag
  • help

Footer

AskOverflow.Dev

About Us

  • About Us
  • Contact Us

Legal Stuff

  • Privacy Policy

Language

  • Pt
  • Server
  • Unix

© 2023 AskOverflow.DEV All Rights Reserve