Escolha sabiamente sua estratégia de produção Rdoc!

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br


[Esteartigofoipublicadopelaprimeiravezem[Thisarticlewasfirstpublishedon NEONIRA, e gentilmente contribuiu para os R-blogueiros]. (Você pode relatar um problema sobre o conteúdo desta página aqui)


Deseja compartilhar seu conteúdo com R-blogueiros? clique aqui se você tiver um blog ou aqui se não tiver.

[1]

Última postagem ‘Ainda crie seu Rdoc manualmente
arquivos?’
pacote introduzido
wyz.code.rdoc para produzir
R arquivo de documentação em um possivelmente totalmente
maneira automatizada. Vamos ver hoje, qual estratégia de produção oferecerá a você
a maneira mais poderosa e produtiva de produzir esses
R arquivos de documentação.

Armas disponíveis

Lembre-se que pacote wyz.code.rdoc apontar para
gerar documentação a partir do código, por código. Fornece muitas armas
para fazer isso, e vamos rever aqui os mais importantes

  1. o ProcessingContext classe permite que você
    definir dois tipos de ações para modificar o conteúdo da documentação
    1. A estranho ação para adicionar sob demanda
      seções estranhas na documentação gerada
    2. UMA pós-processamento ação para
      substitua / adapte o conteúdo da documentação como desejar
  2. o atalhos classe permite reutilizar a maioria
    conteúdo de apresentação comum em sua documentação
  3. o embelezar classe permite embelezar
    a apresentação do seu conteúdo

Para saber mais sobre opções, assinaturas e argumentos, use

help(package = 'wyz.code.rdoc')
vignette(package = 'wyz.code.rdoc')

Qualifique sua necessidade

Antes de executar qualquer R arquivo de documentação
produção, você tem que decidir o seu playground. Respondendo a seguir
perguntas é útil para fazê-lo

O arquivo de documentação deve ser regenerado sob demanda?
Se vocês
deseja ter documentação ao longo do seu código ao criar o pacote
a resposta é provavelmente positiva. Se você deseja adiar a documentação
produção até a última vez que a entrega do pacote foi concluída, a resposta é
provavelmente não. Nos dois casos, opte por sistemas totalmente automatizados
R produção de arquivos de documentação. No primeiro caso,
evitar arquivos produzidos manualmente, no segundo caso, você é livre para
faça isso.

Leia Também  A Premier Machine Learning Conference (código de desconto de 15%)

Você gastará tempo para polir arquivos produzidos manualmente?
Enquanto
você geralmente deve evitar retoques nas mãos, às vezes um
edição eficiente do arquivo pode ser preferida a uma edição mais longa e possivelmente
processamento complicado para chegar ao resultado desejado.

Por exemplo, ao marcar uma R pacote, há
são verificações relacionadas ao comprimento das linhas de documentação. Corrigindo isso
manualmente ou por um pós-processamento ação terminou
a sua escolha. Mas o tempo necessário em cada sentido pode ser muito
diferente. Se você procura alta produtividade imediata, escolha sabiamente.
Não há como decidir fora do contexto qual tática é a melhor para
seu caso.

O código do seu pacote possui muitos parâmetros de função idênticos
nomes?

Nesse caso, a estruturação de peças reutilizáveis ​​será
permitem ganhar muito tempo enquanto gera todas as documentações de
seu R pacote, garantindo maior
consistência. Pacote wyz.code.rdoc é muito
útil nesse caso.

Maneira industrial de produzir documentação

Você tem que saber isso wyz.code.rdoc página de manual
produção depende de

  1. o tipo de documentação que você deseja gerar:
  2. seu R código de sabor

Os tipos de documentação são padrão e estão relacionados ao destino do
página de manual: função,
classe, pacoteou
dados. Quando você produz uma dessas páginas de manual
tipos, você deve cumprir um conjunto diferente de requisitos em
presença de seção, conteúdo da seção e muito provavelmente também na seção
apresentação.

Seu R O sabor do código também afeta o volume de
trabalho que você precisará realizar para obter uma página de manual corretamente preenchida,
bem formatado, consistente com outras páginas de manual da sua embalagem,
e fácil de ler. O seu código é R padrão
código
ou é programação ofensiva R
código
.

Do código R padrão à página de manual

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br

A geração manual de páginas é parciale você
tem que fornecer estranho e
pós-processamento ações para gerar sua
conteúdo. Se você não fizer isso, cada página de manual gerada permanecerá
incompleto e não passará nos testes de pacotes. Por isso, documentação
conclusão é requeridos.

Considerando um função ou
classe página de manual, você deve fornecer conteúdo
para seções exemplos e
descrição, pelo menos. Você também
provavelmente precisará fornecer conteúdo para a seção
detalhes e valores.

Considerando um pacote página de manual, você deve
fornecer conteúdo para seções descrição e
provavelmente conteúdo para a seção detalhes.

Considerando um dados página de manual, você deve
fornecer conteúdo, pelo menos para seções formato
e fonte.

Da programação ofensiva do código R à página do manual

Usando código R de programação ofensiva facilita
produção de páginas muito manual. Como, isso é baseado no argumento semântico
nomeação, o conteúdo de muitos campos é gerado a partir do código sem ônus extra
permitindo que você cumpra os requisitos da seção de documentação
sem qualquer informação estranha.

  1. a descrição do parâmetro é inferida a partir do nome do parâmetro semântico e
    geralmente não exigem nenhuma alteração. Como isso se aplica a cada
    argumento de cada função do seu pacote, esse recurso é um ótimo
    benefício e permite ganhar muito tempo,
  2. descrição é inferida a partir de classe e função ofensiva
    esquema de nomeação de programação. Se você respeitou sua
    rigoroso modo, espere que o conteúdo produzido seja
    afiado e finalizado. Caso contrário, você provavelmente precisará aperfeiçoar sua
    conteúdo, por um pós-processamento ação ou alguma
    retoques de mão.
Leia Também  O primeiro padrão de projeto de programação no pxWorks

A geração manual de páginas é cheio exceto por
dados onde você precisa fornecer conteúdo, como
descrito acima. Em todos os outros casos, as páginas de manual geradas estão completas
e pronto para visualização e revisão humana.

Escolha a melhor estratégia de acordo com o seu caso

Primeiro, seja qual for o seu Sabor do código R, um bem
documentação requer exemplos. Isso é provavelmente
a parte mais importante da sua documentação, faça o polimento. Eu já
mostrado no post anterior, como é fácil declarar essas informações,
gerar uma página de manual.

Trabalhando sob código R padrão, fornecem
estranho e postar
em processamento
informação em
ProductionContext definição, geração anterior,
a fim de cumprir os requisitos relacionados ao tipo de
página de manual gerada. Isso permitirá a produção imediata de
páginas de manual compatíveis.

Usando código R de programação ofensiva, pense
suprir estranho informação em
ProductionContext definição, geração anterior,
a fim de cumprir os requisitos relacionados ao tipo de
página de manual gerada.

Próximo post

Vimos isso wyz.code.rdoc pacote permite
totalmente automatizado e reproduzível R página de manual
Produção. Ajuda a reforçar o nível de consistência necessário / desejado
Para o seu R arquivos de documentação no seu
pacotes.

Não mencionado anteriormente, mas bastante óbvio, usando
wyz.code.rdoc facilita a documentação incremental
geração. Ao criar um pacote, o fluxo de trabalho geralmente é criado
e depure o código, crie teste e crie documentação.

Com wyz.code.rdoc, você pode adotar um
abordagem orientada a domínio, que é criar exemplos de domínio, implementar e
código de depuração, gere documentação com base em exemplos de domínio, crie
testa a reutilização em exemplos de domínio prioritário. Dessa forma, a geração de código
processo é realmente incremental e orientado a domínio.

Leia Também  Verificação móvel da Mitek selecionada pelo novo operador de criptomoedas, DXE

Em pacotes de tamanho pequeno, isso não faz uma diferença significativa, mas
pacotes grandes e grandes, isso facilita muito a produção, principalmente
quando muitos programadores estão trabalhando no mesmo pacote. A documentação pode
ser gerado automaticamente ou sob demanda ao mesmo tempo em que o código é
entregues, aumentando assim a visibilidade e a reutilização imediata.

Se você busca uma colaboração mais alta e um efeito de túnel mais curto,
para entregas incrementais de funcionalidades do pacote é poderoso e
wyz.code.rdoc automatiza a documentação
atividades de produção para sustentar sua produtividade.

O próximo post fornecerá wyz.code.rdoc dicas e
truques que vale a pena conhecer para obter geração produtiva de documentação.

[1] O negócio
foto criada por yanalya – freepik.com



Se você chegou até aqui, por que não inscreva-se para atualizações do site? Escolha o seu sabor: e-mail, twitter, RSS ou facebook …



cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br