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 . o objetivo é...
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 há 4 anos . Eu sempre me...
Após muita pesquisa, não consegui responder a uma pergunta básica referente a um suposto conhecido no mundo do desenvolvimento de software: O QUE É CONHECIDO: A imposição de uma política rigorosa na documentação adequada do código (sejam tags Doxygen, Javadoc ou simplesmente uma abundância 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 . Alguém já...
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 há 5 anos . Estive lendo algumas...
Eu quero melhorar minhas habilidades de programação estudando projetos de código aberto famosos, mas acho que é fácil se perder apenas pulando no código-fonte. Então, decidi ler a documentação deles sobre o design ou a arquitetura (como diagramas UML) para ter uma idéia geral da organização do...
Nosso software possui várias classes que devem ser encontradas dinamicamente via reflexão. Todas as classes têm um construtor com uma assinatura específica através da qual o código de reflexão instancia objetos. No entanto, quando alguém verifica se o método é referenciado (por exemplo, através do...
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 há 4 anos . Eu completei um...
Atualmente, estou trabalhando na minha graduação para meus estudos de "Desenvolvimento de Software", nos quais tenho que desenvolver software complexo individualmente em uma empresa externa. Tudo isso precisa ser feito de maneira estruturada, criando todos os documentos correspondentes. Para este...
Na minha opinião, os casos de teste de unidade em si servem como uma documentação para o código. Minha empresa quer que eu escreva comentários detalhados sobre java doc sobre os casos de teste de unidade. É necessário fazer isso? Você escreve comentários
Ocasionalmente, há 1% de código que é intensivamente computacionalmente e precisa do tipo mais pesado de otimização de baixo nível. Exemplos são processamento de vídeo, processamento de imagem e todos os tipos de processamento de sinal, em geral. Os objetivos são documentar e ensinar as técnicas...
Eu tenho um projeto para a universidade que não iniciarei imediatamente, mas tenho pensado por um período razoavelmente longo. Eu entendo que o desenvolvimento de projetos da Universidade não é como a indústria (atualmente sou estagiário), então a situação que vou apontar no momento provavelmente...
Quando escrevo pequenos scripts para mim, empilhar meu código com comentários (às vezes comento mais do que codifico). Muitas pessoas com quem falo dizem que devo documentar esses scripts, mesmo que sejam pessoais, para que, se eu os vender, eu estaria pronto. Mas os comentários não são uma forma...
Estamos procurando reformular a documentação em toda a nossa linha de produtos. Parte disso inclui manuais de referência para uma linguagem de programação usada como parte do sistema. Ao escrever um manual de referência para uma linguagem de programação, qual é a melhor maneira de estruturá-lo...
Existem práticas comuns para comentar as expressões regulares: comentários embutidos que referem parte diferente do RegEx ou comentário geral para todas as
Fechadas. Esta questão está fora de tópico . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela esteja no tópico do Software Engineering Stack Exchange. Fechado há 6 anos . Eu sou um defensor de...
Temos muitos documentos associados ao nosso desenvolvimento de software. Isso inclui requisitos, documentos de design, PDFs externos, arquivos de clientes, instruções de teste etc. Atualmente, esses documentos estão espalhados por todo o lugar (wiki, "algum lugar na rede", um disco rígido local...
É difícil dizer o que está sendo pedido aqui. Essa pergunta é ambígua, vaga, incompleta, excessivamente ampla ou retórica e não pode ser razoavelmente respondida em sua forma atual. Para obter ajuda para esclarecer esta questão para que possa ser reaberta, visite o centro de ajuda...
Uma parte essencial do Design Orientado a Domínio é o uso consistente de uma linguagem onipresente em todo o sistema - em conversas, código, esquema de banco de dados, interface do usuário, testes, etc. Estou envolvido em um projeto no qual já existe uma linguagem de domínio bem estabelecida,...
Sou um defensor do código devidamente documentado e estou ciente das possíveis desvantagens dele . Isso está fora do escopo desta questão. Eu gosto de seguir a regra de adicionar comentários XML para cada membro público, considerando o quanto eu gosto do IntelliSense no Visual Studio. Existe uma...