Como lidar com um quadro indocumentado API / sob .NET? [fechadas]

Question

Para o trabalho que eu tenho que código com API de uma empresa externa para lidar com a sua solução de banco de dados proprietário. Infelizmente a documentação que eles fornecem é mais de um guia exemplo, em seguida, docs API apropriadas, por isso é muito leve em pequenos pormenores, como os códigos de erro método retorna, e exceções.

Assim, por exemplo, uma classe terá um método .GetErrorCode (), mas não tenho idéia do que esses números de erro significa porque eles não fizeram documento que número corresponde com o que erro. Em muitos casos, um método retornará um objeto, sem documentação de qual o tipo de objeto que ele realmente retorna. Pedi-los várias vezes por documentação adequada, mas eles parecem pensar que detalhes como os acima são segredos decoro. Assim, há quaisquer ferramentas ou métodos que podem trabalhar em torno de meu limitado ou, em alguns casos, a documentação inexistente.

Por favor, note que estou usando Visual Studo 2005 e codificação em C # sob .Net.

E antes de respostas ninguém "não utilize a API", eu tenho que, é para o trabalho.

Answer 1

Um cenário desagradável. Eu odeio a sugerir isso, mas talvez refletor é seu amigo se ele não está ofuscado . Pode haver algumas questões de PI, mas, neste caso, invertendo parece que a única maneira viável de descobrir o que a API é. No entanto, eu suspeito (a partir de métodos como .GetErrorCode ()) que este é um calço no topo de P / Invoke - caso em que, mesmo refletor só vai mostrar-lhe lotes de chamadas externas ...

A principal coisa que posso dizer é: escreva muitos de testes de unidade que a cobertura como você está tentando usá-lo ... dessa forma, se você adivinhar mudanças erradas e alguma coisa, você vai saber precoce.

Answer 2

Se eu não puder obter amostras de código ou falar com um desenvolvedor original, eu costumo recorrer a refletor de olhar para o código subjacente. É lento e ineficiente, mas às vezes isso é tudo o que você pode fazer.

Answer 3

Depende da sua situação. Se você está pagando para o API, você deve continuar a pressionar a empresa para melhor documentação de como usar a API.

Se isso não vai funcionar, o que eu gostaria de fazer é começar a minha própria documentação como eu desenvolver. Manter um notebook, um Wiki pessoal ( ScrewTurn wiki vem à mente), ou algum tipo de eletrônico documentação. Como algumas outras pessoas mencionados, você pode usar o refletor para ajuda chegar à fonte (se não for ofuscado).

Criar o seu próprio documentação pode não ser o que você estava procurando, mas se você não pode obter a documentação real, pelo menos criar alguns como você aprende coisas de modo que você pode ter algo para guiá-lo alguns meses (ou anos) no caminho quando você está tentando manter o código construído com a API.

Answer 4

Melhores ferramentas que vêm à mente incluem telefone e e-mail. Esperamos que você pode continuar incomodando pessoas com mais de lá até que eles dão-lhe informação mais útil ...: (

Answer 5

Use refletor para ver o código fonte. Deve mostrar-lhe o Enum para a mensagem getErrorCode.

refletor, por sinal, é o maior programa na história do universo.