Estou tendo uma função que aceita um parâmetro de string. Este parâmetro pode ter apenas um dos poucos valores possíveis definidos. Qual é a melhor maneira de documentar o mesmo? O shapeType deve ser definido como enum ou TypeDef ou algo mais? Shape.prototype.create = function (shapeType) { //...
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...
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 esta postagem . Fechado há 2 anos . Melhore esta...
Estou tentando fazer alguma herança de classe em Python. Eu gostaria que cada classe e classe herdada tivessem boas docstrings. Então eu acho que para a classe herdada, eu gostaria que: herdar a docstring da classe base talvez anexe documentação extra relevante ao docstring Existe alguma...
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á 4 anos . Melhore esta questão...
Usando JavaDoc, como posso fazer referência ao valor de um campo estático final na classe? Quero que ???neste exemplo seja substituído pelo valor do campo STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference...
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á 3 anos . Melhore esta questão...
Fechado . Esta questão precisa ser mais focada . Atualmente não está aceitando respostas. Quer melhorar esta questão? Atualize a pergunta para que ela se concentre em apenas um problema, editando esta postagem . Fechado há 2 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...
Como está atualmente, esta pergunta não se encaixa em nosso formato de perguntas e respostas. Esperamos que as respostas sejam apoiadas por fatos, referências ou experiência, mas esta pergunta provavelmente irá solicitar debate, argumentos, pesquisas ou discussão extensa. Se você...
Suponha que, como parte da documentação de seu código (Javadoc), você deseja indicar que as relações entre os elementos usam recuo profundo. Como posso criar uma lista aninhada como: algum elemento algum outro elemento ainda algum outro elemento
Digamos que temos uma função API complexa, importada de alguma biblioteca. def complex_api_function( number, <lots of positional arguments>, <lots of keyword arguments>): '''really long docstring''' # lots of code Quero escrever um invólucro simples em torno dessa função para...