Perguntas com a marcação «documentation»

Por que a documentação em alguns idiomas diz "equivalente a" em vez de "é"? Por exemplo, os documentos do Python dizem itertools.chain(*iterables) ... Equivalente a: def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element Ou esta referência …

23 c++  python  documentation  compiler 

Fechado . Esta questão precisa ser mais focada . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela se concentre apenas em um problema editando esta postagem . Fechado no ano passado . Desejo documentar meu código de forma que haja uma necessidade …

22 documentation  code-reviews  documentation-generation  help-documentation 

Parece um assunto controverso documentar tudo, incluindo a sintaxe "JavaBean" de getters e setters para campos: as pessoas dizem que é DRY desnecessariamente longo e repetitivo (não se repita) , que a convenção de nomenclatura deve explicar tudo , e confunde código / documentação. Às vezes, esses argumentos funcionam. Mas …

22 documentation 

Não consigo contar o número de vezes que leio declarações na veia de 'testes de unidade são uma fonte muito importante de documentação do código em teste'. Não nego que sejam verdadeiras. Mas, pessoalmente, nunca me vi usando-os como documentação. Para as estruturas típicas que eu uso, as declarações do …

22 unit-testing  documentation 

No momento, estamos escrevendo especificações funcionais e técnicas em um formato de duas colunas; frase sumária e detalhes técnicos. Os detalhes geralmente se referem a um apêndice com diagramas, desenhos de layout etc. No entanto, estou lutando com que tensão para escrevê-lo: No passado, como se o trabalho estivesse terminado, …

21 documentation  specifications  writing 

Antecedentes: Meus colaboradores e eu estamos escrevendo um artigo para uma revista acadêmica. No decorrer de nossa pesquisa, escrevemos um programa de simulação em Java. Queremos tornar o programa de simulação disponível gratuitamente para uso de outras pessoas. Decidimos hospedar o código em um repositório do GitHub. Para facilitar o …

20 java  documentation 

Então nós temos uma interface assim /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Recentemente, reproduzimos uma história de documentação que …

20 c#  documentation  xml  documentation-generation 

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á 6 anos . Depois de passar mais de um ano trabalhando em …

19 documentation  hiring  outsourcing  knowledge-transfer  wordpress 

Às vezes, embora não frequentemente, tenho que incluir lógica matemática no meu código. Os conceitos usados ​​são geralmente muito simples, mas o código resultante não é - muitas variáveis ​​com objetivos pouco claros e algumas operações com intenções não tão óbvias. Não quero dizer que o código seja ilegível ou …

19 java  documentation  math 

Recentemente, tenho trabalhado na refatoração de partes da base de código com a qual estou lidando atualmente - não apenas para entender melhor, mas também para facilitar para outras pessoas que estão trabalhando no código. Costumo me apoiar no lado de pensar que o código de auto-documentação é bom . …

18 java  documentation  refactoring  javadocs 

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á 5 anos . Todo mundo sabe que o desenvolvimento de software bem …

18 documentation  wiki 

Suponha que você seja o único desenvolvedor a deixar um emprego. Que tipo de informação / material, fora do próprio código, você deve criar e deixar para sua substituição? Uma resposta óbvia é "o que você deseja em um novo emprego", com certeza, mas já faz um tempo desde que …

18 documentation  knowledge-transfer 

Estive estudando como documentar projetos de software de maneira mais formal e aprendi sobre o IEEE 830-1998: Prática recomendada para especificações de requisitos de software . No entanto, como você pode ver nesse link, ele foi substituído. Eu sei que 830-1998, e provavelmente até 830-1993, provavelmente são ótimos para uso. …

17 documentation  requirements  standards 

Todos nós já vimos inúmeros exemplos de software que são fornecidos com "requisitos mínimos de sistema", como os seguintes: Windows XP / Vista / 7 1GB RAM 200 MB de armazenamento Como são geralmente determinados? Obviamente, às vezes há restrições específicas (se o programa ocupa 200 MB no disco, isso …

17 documentation  requirements  qa 

Um dos desenvolvedores da minha equipe acredita que é necessário escrever um comentário javadoc para TODOS os parâmetros na assinatura de um método. Não acho que isso seja necessário e, de fato, acho que pode até ser prejudicial. Primeiro, acho que os nomes dos parâmetros devem ser descritivos e auto-documentados. …

17 java  documentation  source-code  comments  maintainability