ESTA TAG É APENAS PARA GERADORES DE DOCUMENTOS. Inclui linguagem e / ou tag SDE também. NÃO USE para pedir links para documentação ou ferramentas, ou para criticar a documentação do fornecedor.
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...
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
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...
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...
Ao escrever a documentação xml, você pode usar <see cref="something">something</see>, o que funciona, é claro. Mas como você faz referência a uma classe ou a um método com tipos genéricos? public class FancyClass<T> { public string FancyMethod<K>(T value) { return...
Isso deve ser muito mais fácil ... Eu quero adicionar uma quebra de linha "codificada" à documentação XML no meu código /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. <br/> /// Rather than return SQL, this method returns a...
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...
Sei que não é o problema mais importante, mas acabei de perceber que posso colocar o bloco de comentários javadoc antes ou depois da anotação. O que gostaríamos de adotar como um padrão de codificação? /** * This is a javadoc comment before the annotation */ @Component public class MyClass {...
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...
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...
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...
Como posso informar o JSDoc sobre a estrutura de um objeto retornado. Eu encontrei a @return {{field1: type, field2: type, ...}} descriptionsintaxe e tentei: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch...
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...
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...
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...
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...
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...
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ê...
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] [,...
A documentação para habilitar a integração de XmlDoc em seus projetos de API da Web parece lidar apenas com situações em que todos os seus tipos de API fazem parte de seu projeto de WebApi. Em particular, ele discute como redirecionar a documentação XML App_Data/XmlDocument.xmle descomentar uma...