Not to start something else but if Autodesk asked, what would you do to the documentation? How would you change/increase/view the documentation?
Self contained documentation, not reliant on reading with something else.
Type Descriptions. (more than a generic 5 word sentence)
Member Descriptions: (ditto)
Usage examples.
Linked References .. for things like enumerators, typed parameters, typed returns
Do not assume that the user has a degree in Computer Science and develops full time .
Some of the examples for the old VBA documentation were quite good.
Drop the idea that VB is easier to learn than C#. Both languages are easy to learn, even if they are syntactically different in some ways ... The API's are what takes the time and effort to learn.
Add Option Strict On and Option Explicit On to all VB samples ... it may make for better translations and a more consistant code standard.
Generally the Parameter naming used in the Reference Guide is quite descriptive (good)
There was a discussion here a couple of weeks ago involving several AutoDesk luminaries (gopinatht, Stephen) The Summary was :
1) Always use the "using" statement with the transaction object
2) Always use the "using" statement with newly created DB Objects being added to the transaction
3) Always using the "using" statement with DB Objects that are not added to the database
4) You dont have to use the "using" statement with existing DB Objects opened with a transaction object
This type of information SHOULD be documented and available to everyone.
I think we all already know what constitutes effective documentation, and are aware that it will become more important as new customisers start to come to grips with dotNet.
As I said earlier, it is time to do something about it, and without further procrastination.
Regards
kdub
