The best feature you could add would be in the docs

SyntaxEditor for Windows Forms Forum

Posted 12 years ago by Bob Puckett
Version: 4.0.0253
Avatar
We use Syntax Editor for a custom language that we use for development. It works great - but the best new feature you could possibly add would be descriptions of each class and method and property telling what they actually do and how to use them. The autogenerated parameter lists are just not enough to make using the control easy. Being told, "just look at the sample source code" isn't quite enough either. Can you imagine using the Microsoft .NET libraries if all you had was something like "FindReplaceForm Class : Represents a built-in Find and Replace form."? I don't think the guys who wrote SyntaxEditor could not have done it if the .NET framework was documented with nothing more than a class heirarchy and a member list from an automated doc generation tool.

Thanks for the great control, but please help with the docs.

Comments (2)

Posted 12 years ago by Matt Adamson
Avatar
Have you reviewed on the document provided, this provides good documentation on each class, although I would like to see example sections used more in some places.
Posted 12 years ago by Actipro Software Support - Cleveland, OH, USA
Avatar
Hi Bob,

Thanks for the comments. We do try and add some short remarks to various members throughout the code when we think it will help. We try our best to provide very detailed documentation but rather than having the detailed docs throughout the generated class library portions where most people wouldn't find them unless they happened to hit on the right type/member, we put most of the "meat" of the documentation in the non-class library portion of the documentation. For instance, right now the SyntaxEditor documentation has about 220 topics outside of the class library, which is probably a lot more help than you will find with other vendor products.

However that being said, we always want to make things easier for our customers. So if you have any further suggestions on how we should organize our documentation better, we'd love to hear them. More importantly if you look through the documentation and find that a certain topic is not clear or doesn't provide enough information, we can try to improve those topics.

We also have tried to do a good job making both real world samples and QuickStarts that show off the various feature areas.


Actipro Software Support

The latest build of this product (v2018.1 build 0341) was released 3 months ago, which was after the last post in this thread.

Add Comment

Please log in to a validated account to post comments.