| View previous topic :: View next topic |
| Author |
Message |
primeminister Site Admin

Joined: 16 Apr 2006 Posts: 94 Location: Netherlands
|
Posted: Tue Apr 18, 2006 11:52 am Post subject: Adding examples |
|
|
Am I expected to add examples and/or test files to my package and where to store them?
Last edited by primeminister on Tue Apr 18, 2006 12:13 pm; edited 1 time in total |
|
| Back to top |
|
 |
primeminister Site Admin

Joined: 16 Apr 2006 Posts: 94 Location: Netherlands
|
Posted: Tue Apr 18, 2006 11:52 am Post subject: |
|
|
Examples are a good idea, especially when your class has a complex API. But examples are only a part of a documentation. Don't create examples instead of a documentation. You should store the documentation and the examples in a sub directory 'docs' of the package directory.
Test scripts are recommended when your class has to be compiled, requires special extentions/programs or needs correctly installed additional files (i.e. templates, graphics). Store them in sub directory called 'tests'. |
|
| Back to top |
|
 |
|
|
You cannot post new topics in this forum You cannot reply to topics in this forum You cannot edit your posts in this forum You cannot delete your posts in this forum You cannot vote in polls in this forum
|
|