Discussion :

[c-top]

Voila j'ai une idée d'API et avant de me lancer dans le développement j'aurais voulu avoir quelques conseils sur les règles à respecter lors de la construction d'une API ou d'un package.

Merci à vous.

[afrikha]

je pense qu'il faut bien documenté le code et pas seulement la javadoc, idéalement ecrire une documentation ou une sorte de guide de l'utilisateur avec des exemples d'utilisation.
De point de vue technique, je te conseille de faire des tests unitaires solides en envisageant tous las cas possible d'utilisation.

[lunatix]

tu peux aussi en parler, histoire de voir si d'autres gens sont motivés pour t'aider

sinon, javadoc, test unitaire (Junit histoire d'etre "standard"), et une doc.
prevoir des interfaces simples si possible

[yann2]

bonjour,

Bien penser l'API avant de coder (besoins, ...).

Analyse
UML + Design Pattern

Codage
Audit avec JDepend ou JavaNCSS

Approche XP en commençant par coder les contrats puis les tests puis
l'implémentation.

Et certainement encore plus !

[c-top]

Merci pour ces quelques réponses

Pouvez-vous me donner des eclaircissements sur la notion de
- contrat
- et test

Pour en dire un peu plus ce sera une API de chimie orientée dans un premier temps chimie en solution.

[billynirvana]

Si ton API interesse plusieurs domaines, exxaye de rendre ton api flexible.

cad par exemple que les entrées de tes méthodes soit du plus bas niveau possible.

[yann2]

re,

Les contrats :

Donner les spécifications de chaque classe avant de faire l'implémentation.
En résumé c'est presque faire une interface pour chaque classe que tu as indetifié pendant l'analyse. Tu y spécifie les entrées, sorties, "qu'est ce que ça fait", les exceptions lancées, pré conditions, post conditions

Puis coder les tests unitaires (qui pourront être réutilisés pour des tests de non régression), je te conseille JUnit

Puis coder l'implémentation et exécuter les tests dessus.