Documenting service api's

Hi guys,

Do you have any recommendations (tools, project structure, etc) for documenting the public API of a service? I'd like to produce docs that keep the public interface separate from the internals.

thanks,
R

[227 byte] By [RobSim--Braintech] at [2008-2-28]
# 1

If you are looking for tools to generate html help from your XML documented classes, here are the ones I can suggest:

NDoc

http://ndoc.sourceforge.net/

Microsoft Sandcastle

http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&DisplayLang=en

OmidK.Rad at 2007-9-25 > top of Msdn Tech,Microsoft Robotics Studio,Microsoft Robotics - Decentralized Software Services (DSS)...
# 2
Thanks Omid,

This wasn't quite what I meant to ask, but now I have the answer. I wanted to document the public dss interface to my service, as opposed to the C# class and its methods. I finally realized I can use sandcastle on the generated proxy class and I'm done.

cheers,
R

RobSim--Braintech at 2007-9-25 > top of Msdn Tech,Microsoft Robotics Studio,Microsoft Robotics - Decentralized Software Services (DSS)...

Microsoft Robotics Studio

Site Classified