O utilitário QuickBook para C ++

QuickBook é um add-on para BoostBook. Este utilitário começou como projeto de fim de semana de alguém. Originalmente, QuickBook emitido documentos HTML simples. No entanto, agora ele gera XML no formato BoostBook de modo que você pode rapidamente gerar a documentação que liga com o resto da documentação para o seu projeto. QuickBook é um instrumento de documentação estilo WikiWiki.

É importante notar que algumas pessoas simplesmente chamá-lo um Wiki ou Wiki-Wiki ou mesmo Wiki Wiki. Todos os termos significam a mesma coisa.

Antes de usar QuickBook, você gerar um arquivo de documentação. Confira esta completa resumo sintaxe para QuickBook.

Neste ponto, você provavelmente está se perguntando por que você deve usar QuickBook em tudo, desde que você tem para gerar um arquivo de documento para ele de qualquer maneira. Aqui estão as razões pelas quais muitos desenvolvedores usam QuickBook vez de confiar em BoostBook diretamente:

  • A sintaxe QuickBook é mais fácil de ler e usar do que escrever XML.

  • Você pode usar QuickBook para gerar a documentação não-Boost.

  • É relativamente fácil para converter outros formatos de documentação para sintaxe QuickBook.

QuickBook é um utilitário de linha de comando. Você encontrá-lo na CodeBlocks boost_1_55_0 dist bin directório depois de gerar as ferramentas de impulso. Aqui estão os de linha de comando que você pode acessar quando se trabalha com QuickBook:

  • --Socorro: Exibe uma mensagem de ajuda que mostra todas as opções de linha de comando, bem como a sintaxe de linha de comando.

  • --versão: Exibe informações sobre a versão do QuickBook.

  • --não-pretty-print: Desactiva a impressão XML e usa texto simples ao invés.

  • --recuar arg: Define o número de espaços para usar para travessões (conforme especificado pelo arg).

  • --espessura da linha arg: Define o número de caracteres em uma única linha.

  • --Arquivo de entrada arg: Especifica o nome do arquivo de entrada.

  • --arquivo de saída arg: Especifica o nome do arquivo de saída.

  • --depurar: Lugares QuickBook no modo de depuração (útil apenas para desenvolvedores que querem mexer com o executável).

  • --ms-erros: Especifica que QuickBook deve usar o estilo Microsoft Visual Studio de erros e avisos no formato de mensagem de saída. Esta opção pode fazer QuickBook mais fácil para desenvolvedores do Microsoft Visual Studio de usar e entender.

Semelhante

menu