Perguntas com a marcação «documentation»

Recentemente, comecei a estudar Python , mas não consegui descobrir como implementar comentários de várias linhas. A maioria dos idiomas possui símbolos de comentário de bloco como /* */ Eu tentei isso em Python, mas ele gera um erro, então essa provavelmente não é a maneira correta. O Python realmente …

1157 python  comments  documentation 

No Objetivo C, posso usar #pragma markpara marcar seções do meu código no navegador de símbolos. Como esse é um comando do pré-processador C, não está disponível no Swift. Existe um substituto para isso no Swift, ou eu tenho que usar comentários feios?

936 swift  documentation 

Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 2 anos . Eu já vi alguns estilos diferentes de escrever docstrings …

888 python  coding-style  documentation  docstring 

Atualmente, essa questão não se encaixa no nosso formato de perguntas e respostas. Esperamos que as respostas sejam apoiadas por fatos, referências ou conhecimentos, mas essa pergunta provavelmente solicitará debates, argumentos, pesquisas ou discussões prolongadas. Se você acha que essa pergunta pode ser melhorada e possivelmente reaberta, visite o centro …

258 documentation  comments 

Fechadas. Esta pergunta não atende às diretrizes de estouro de pilha . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela esteja no tópico do Stack Overflow. Fechado há 2 anos . Melhore esta pergunta Um dos novos recursos do Xcode 5 é …

186 objective-c  documentation  comments  doxygen  xcode5 

Então, eu entendo completamente como usar a nova amostra , mas a documentação não faz um bom trabalho explicando as opções. Portanto, a maioria das opções na resamplefunção é bastante direta, exceto as duas: regra: a sequência ou o objeto de deslocamento que representa a conversão de destino how: string, …

184 python  documentation  pandas 

Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 2 anos . Melhore esta pergunta Ok, então eu li o PEP …

167 python  documentation  module 

Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 2 anos . Melhore esta pergunta Atualmente, estou começando com Python e …

162 python  documentation  javadoc  docstring 

Atualmente, estou escrevendo uma pequena estrutura que será usada internamente por outros desenvolvedores da empresa. Desejo fornecer boas informações do Intellisense, mas não sei como documentar exceções lançadas. No exemplo a seguir: public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public void MyMethod2() { System.IO.File.Open(somepath...); // this …

139 c#  .net  documentation  intellisense 

Como documentar métodos com parâmetros usando as strings de documentação do Python? EDIT: PEP 257 dá este exemplo: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: …

139 python  documentation  documentation-generation 

Fechadas. Esta pergunta não atende às diretrizes do Stack Overflow . Atualmente não está aceitando respostas. Quer melhorar esta questão? Atualize a pergunta para que esteja no tópico do Stack Overflow. Fechado há 12 meses . Melhore esta questão Estou tentando encontrar documentação para usar a API C FFmpeg. Parece …

119 c  api  documentation  ffmpeg 

Fechado . Esta pergunta é baseada em opinião . Atualmente não está aceitando respostas. Quer melhorar esta questão? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando este post . Fechado há 6 anos . Melhore esta questão TeX / LaTeX é ótimo, eu o …

118 documentation  latex  tex 

Fechado . Esta pergunta é baseada em opinião . Atualmente não está aceitando respostas. Quer melhorar esta questão? Atualize a pergunta para que possa ser respondida com fatos e citações editando este post . Fechado há 2 anos . Melhore esta questão Estou escrevendo uma classe leve cujos atributos devem …

115 python  class  documentation  docstring  class-attributes 

No JSDoc, a melhor documentação que posso encontrar mostra como usar o seguinte se você tiver uma matriz de um tipo específico (como uma matriz de strings) como: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Como você substituiria os pontos de interrogação …

105 javascript  documentation  jsdoc 

Existe um padrão para interpretar a sintaxe das interfaces de função em documentações de API e, em caso afirmativo, como é definido? Aqui está um exemplo de como alterar a cor de um item do guia de script JavaScript para Photoshop para a função "fillColor": fillPath ([fillColor] [, mode] [, …

103 api  documentation