4 replies to this topic

[Zoot]

Here's a suggestion for Chris, or anyone else that would like to take a shot at it. Even me. I've noticed when using the Secret Labs SDK functions, that a description of the function and its' parameters doesn't show up in Intellisense. You get the name and arguments, but no small description, like "Writes byte to serial port" or "Toggles specified pin true or false." Chris, maybe you could add this to the next release of the SDK, please? If you and your staff don't have the time, maybe we can make this a community effort, though it would be better if SL did it due to familiarity with the code. It's only XML commentary in the source code, after all. Thoughts?

[hanzibal]

I'm also missing this but maybe it has to do with keeping flash requirements to a minimum? In general, I think documentation is poor, but I could be missing something here.

[Zoot]

I'm also missing this but maybe it has to do with keeping flash requirements to a minimum?

In general, I think documentation is poor, but I could be missing something here.

I'll agree that the documentation is poor, but hopefully that will improve.

The Intellisense information doesn't go into flash, I wouldn't think. It's based on sets of XML comments in the raw C# code which are omitted from the code image at compile time, or when the DLL is compiled. We see them, but the Netduino would not.

Here's a partial example from Microsoft's Unity Framework source code. It's just the Intellisense XML and the method signature to illustrate my point:

/// <summary>
        /// Register a type with specific members to be injected.
        /// </summary>
        /// <param name="container">Container to configure.</param>
        /// <param name="t">Type this registration is for.</param>
        /// <param name="injectionMembers">Injection configuration objects.</param>
        /// <returns>The <see cref="UnityContainer"/> object that this method was called on (this in C#, Me in Visual Basic).</returns>
        [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "t")]
        public static IUnityContainer RegisterType(this IUnityContainer container, Type t, params InjectionMember[] injectionMembers)

All of the information on how to use the method is there in the XML comments. When you're editing this code in Visual Studio, that is the info that pops up when you hover over a method name.

[baxter]

I came across this a while back, http://informatix.mi...umentation.aspx Baxter

[Zoot]

I came across this a while back,

http://informatix.mi...umentation.aspx

Baxter

A little outdated, but not by much. I've added it to my toolbox. Thanks for the tip!