Soluções alternativas para comentários multilinha?

Eu (meio que) já sei a resposta para essa pergunta. Mas percebi que é uma pergunta tão frequente na lista de usuários R, que deveria haver uma resposta sólida e boa. Até onde sei, não há funcionalidade de comentário em várias linhas em R. Então, alguém tem boas soluções alternativas?

Embora um pouco de trabalho em R geralmente envolva sessões interativas (o que lança dúvidas sobre a necessidade de comentários em várias linhas), às vezes tive que enviar scripts a colegas e colegas de classe, muitos dos quais envolvem blocos de código não triviais. E para pessoas que vêm de outras línguas, é uma pergunta bastante natural.

No passado, usei citações. Uma vez que as strings suportam quebras de linha, executando um script R com

"
Here's my multiline comment.

"
a <- 10
rocknroll.lm <- lm(blah blah blah)
 ...

funciona bem. Alguém tem uma solução melhor?

Isso aparece na lista de discussão com bastante regularidade, veja por exemplo este tópico recente em r-help . A resposta de consenso geralmente é a mostrada acima: dado que a linguagem não tem suporte direto, você deve

• trabalham com um editor que tem comandos região para comentário, e a maioria dos editores R avançados fazem
• use as if (FALSE)construções sugeridas anteriormente, mas observe que ainda requer análise completa e deve, portanto, estar sintaticamente correto

Você pode fazer isso facilmente no RStudio :

selecione o código e clique em CTR+ SHIFT+ C para comentar / descomentar o código.

Um truque interessante para o RStudio que acabei de descobrir é usar, #'pois isso cria uma seção de comentário autoexpansível (quando você retorna para uma nova linha a partir de tal linha ou insere novas linhas em tal seção, é automaticamente um comentário).

[Atualização] Com base em comentários.

# An empty function for Comments
Comment <- function(`@Comments`) {invisible()}

#### Comments ####
Comment( `

  # Put anything in here except back-ticks.

  api_idea <- function() {
    return TRUE
  }

  # Just to show api_idea isn't really there...
  print( api_idea )

`)
####

#### Code. ####
foo <- function() {
  print( "The above did not evaluate!")
}
foo()

[Resposta Original]

Aqui está outra maneira ... confira a foto na parte inferior. Recorte e cole o bloco de código no RStudio.

Comentários multilinha que tornam o uso de um IDE mais eficaz são uma "coisa boa", a maioria dos IDEs ou editores simples não tem destaque de texto dentro de blocos simples comentados; embora alguns autores tenham dedicado tempo para garantir a análise dentro das strings here. Com R, não temos comentários de várias linhas ou aqui também, mas o uso de expressões invisíveis no RStudio oferece tudo isso.

Contanto que não haja crases na seção desejada para serem usados ​​para comentários de várias linhas, strings here ou blocos de comentários não executados, então isso pode valer a pena.

#### Intro Notes & Comments ####
invisible( expression( `
{ <= put the brace here to reset the auto indenting...

  Base <- function()
  {      <^~~~~~~~~~~~~~~~ Use the function as a header and nesting marker for the comments
         that show up in the jump-menu.
         --->8---
  }

  External <- function()
  {
    If we used a function similar to:
      api_idea <- function() {

        some_api_example <- function( nested ) {
          stopifnot( some required check here )
        }

        print("Cut and paste this into RStudio to see the code-chunk quick-jump structure.")
        return converted object
      }

    #### Code. ####
    ^~~~~~~~~~~~~~~~~~~~~~~~~~ <= Notice that this comment section isnt in the jump menu!
                                  Putting an apostrophe in isn't causes RStudio to parse as text
                                  and needs to be matched prior to nested structure working again.
    api_idea2 <- function() {

    } # That isn't in the jump-menu, but the one below is...

    api_idea3 <- function() {

    }

  }

    # Just to show api_idea isn't really there...
    print( api_idea )
    }`) )
####

#### Code. ####
foo <- function() {
  print( "The above did not evaluate and cause an error!")
}

foo()

## [1] "The above did not evaluate and cause an error!"

E aqui está a foto ...

Posso pensar em duas opções. A primeira opção é usar um editor que permite bloquear comentários e descomentar (por exemplo, Eclipse). A segunda opção é usar uma instrução if. Mas isso só permitirá que você 'comente' a sintaxe R correta. Portanto, um bom editor é a solução alternativa preferida.

if(FALSE){
     #everything in this case is not executed

}

Acho incrível que qualquer idioma não atendesse a isso.

Esta é provavelmente a solução mais limpa:

anything="
first comment line
second comment line
"

Além de usar a maneira exagerada de comentar códigos de várias linhas apenas instalando o RStudio, você pode usar o Notepad ++, pois ele suporta o realce de sintaxe de R

(Selecione várias linhas) -> Editar -> Comentar / Descomentar -> Alternar Comentário do Bloco

Observe que você precisa salvar o código como uma fonte .R primeiro (destacado em vermelho)

Eu uso o vim para editar o script R.

Digamos que o script R seja test.R, contendo, digamos, "Linha 1", "Linha 2" e "Linha 3" em 3 linhas separadas.

Eu abro test.R na linha de comando com o Vim digitando "vim test.R". Então, vou para a 1ª linha que desejo comentar, digito "Control-V", seta para baixo até a última linha que desejo comentar, digito I maiúsculo, ou seja, "I" para inserir, digite "#" e, em seguida, aperte a tecla Escape para adicionar "#" a cada linha que eu selecionei com as setas para baixo. Salve o arquivo no Vim e saia do Vim digitando ": wq". As alterações devem aparecer no Rstudio.

Para deletar os comentários no Vim, comece na primeira linha no topo do caractere "#" que você deseja deletar, novamente faça "Control-V", e vá até a última linha que você quer deletar um "#". Em seguida, digite "dd". Os sinais "#" devem ser excluídos.

Há segundos de atraso entre o momento em que as alterações em test.R no Vim são refletidas no Rstudio.

No RStudio, uma maneira fácil de fazer isso é escrever seu comentário e, depois de usar CTRL + Shift + C para comentar sua linha de código, use CTRL + SHIFT + / para refluir seu comentário em várias linhas para facilitar a leitura.

No Python, você faz um comentário em várias linhas com aspas simples 3x antes e depois dos comentários. Eu tentei isso no R e parece funcionar também.

Por exemplo.

'''
This is a comment
This is a second comment
'''