O que é a maneira recomendada para empacotar uma biblioteca de classes C # (DLL)?

StackOverflow https://stackoverflow.com/questions/1228614

  •  22-07-2019
  •  | 
  •  

Pergunta

Estou criando uma biblioteca de classes C # para uso por outros desenvolvedores. Como devo empacotá-lo? - apenas zip-se a DLL e colocá-lo no site

Foi útil?

Solução

A maneira recomendada é carregar o código fonte incluindo scripts de construção de um web site, como GoogleCode para que outros desenvolvedores podem baixá-lo e compilá-lo, mas se ele é uma biblioteca de código fechado fechando o conjunto (MyLibrary.dll), documentação (mylibrary.XML) e arquivo de informações de depuração (mylibrary.PDB) deve ser suficiente.

Outras dicas

Se é apenas uma DLL então eu não incomodar fechando-lo. No entanto, seria bom se você fez zip-se alguma documentação com ele junto com um arquivo de configuração de amostra se for o caso.

Bem, você já usou outro terceiro partido? O que você gostaria de ver no download de terceiros perfeitamente embalado?

Eu fechá-lo acima com o seguinte em no mínimo:

  • seu dll em um bin / / pasta
  • readme (txt ou html) explicando o que é, como instalar e onde obter mais informações

Se você está incluindo a fonte, em seguida, * Fonte / fonte / pasta * Quaisquer testes em um / tests / pasta

Se o seu algo bom que você pode querer ficar-lo no Google Code ou CodePlex, em vez de seu próprio site?

Sim.

Você deve incluir a documentação no seu arquivo ZIP, incluindo um link para seu site. NDoc é ótimo para geração de documentação de seus comentários XML.

Olhe para prijects 3o partido em busca de inspiração, mas sim, uma dll zipado é bom.

Se a documentação for grande, então você deve colocá-lo em um zip separado, e se o seu liberando a fonte que você deve colocar isso em uma 3ª zip.

De qualquer maneira sua DLL deve vem com um readme descrevendo qual versão é, qual é a finalidade, que o escreveu e como entrar em contato com eles, juntamente com quaisquer dependências ou outros trechos de informações úteis.

A documentação é muito importante!

Gostaria de sugerir que, se este é um produto, você gostaria de ter um projeto de instalação que instala-lo. Isso pode incluir colocando-o no GAC e deixando documentação em algum lugar.

editar

Só para esclarecer, eu quero dizer a documentação real, não apenas o que é gerado automaticamente a partir de comentários.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top