Perguntas com a marcação «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á 6 anos . o objetivo é ter um sistema de documentação on-line, …

11 documentation 

O princípio DRY (não se repita) afirma que "todo conhecimento deve ter uma representação única, inequívoca e autorizada dentro de um sistema". Na maioria das vezes, isso se refere ao código, mas também é estendido à documentação. Dizem que todo sistema de software possui uma arquitetura, independentemente de você ter …

11 agile  documentation  architecture  dry 

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 …

11 project-management  business  management  documentation 

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 Visual studio Code Lens), a …

11 c#  .net  documentation  reflection 

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 de …

11 documentation  comments 

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 assim?

11 unit-testing  documentation 

Criamos uma biblioteca comercial e exemplos de código que estão sendo usados ​​por desenvolvedores externos. Temos (fechado, disponível para usuários registrados) documentação que explica extensivamente como usar a biblioteca. Muitos dos desenvolvedores são usuários iniciantes, então muitos erros rudimentares são encontrados. É apropriado incluir links para a documentação no log …

10 documentation  api-design  error-handling  error-messages 

Sou um desenvolvedor amador e todos os meus programas até agora eram simples o suficiente para serem documentados dentro do código. Ao ler o código, ficou claro o que eu estava fazendo tal e tal ação (meu teste padrão foi examinar o código seis meses depois e entender tudo na …

10 architecture  documentation 

Sou o único desenvolvedor de um projeto que, como em qualquer projeto de software, pode ser realizado por outra pessoa no futuro. Digamos que usei o padrão X para implementar o recurso A. Depois de desenvolver e finalizar o recurso, percebo que poderia implementar o mesmo recurso usando o padrão …

10 design-patterns  refactoring  documentation 

Quais informações você espera ver no README do github? Tudo deve estar no README? ie Introdução Instalação Versões Guia de usuario Implementação Teste Recursos Relacionados Ou você deve colocar certas coisas no README (Introdução, Instalação, Versões) e as outras informações são melhor colocadas no wiki do Github?

10 documentation  github 

Eu costumava gostar de exigir comentários XML para documentação. Desde então, mudei de idéia por dois motivos principais: Como um bom código, os métodos devem ser auto-explicativos. Na prática, a maioria dos comentários XML são ruídos inúteis que não fornecem valor adicional. Muitas vezes, simplesmente usamos o GhostDoc para gerar …

10 .net  programming-practices  development-process  documentation  comments 

No momento, estamos usando métodos ágeis no meu projeto atual e temos montes de histórias como estas: Como assistente, quero pagar um reembolso a um cliente para que ele possa receber algum dinheiro quando solicitá-lo Como cliente, quero pagar por uma compra para poder receber meu item. O modo como …

10 agile  documentation  requirements  user-story 

Onde atualmente trabalho, a abordagem geral é - evitar a documentação o máximo possível Documente apenas se uma equipe diferente precisará apenas para esclarecimento, não me refiro à documentação do código - é o que fazemos, quero dizer toda a documentação que envolve o processo de design - se for …

10 documentation 

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 . Atualmente, a equipe que faço parte de uma rotatividade bastante …

10 documentation  training 

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 forma de …

10 documentation  comments  intellisense