Component Level Documentation

Posted by Jason Summers on Stack Overflow See other posts from Stack Overflow or by Jason Summers
Published on 2010-04-04T15:12:50Z Indexed on 2010/04/04 15:23 UTC
Read the original article Hit count: 173

Filed under:

c#

|

component

|

documentation

I'm trying to make good on a promise I've made to provide a decent set of documentation for a C# component that I've written.

I've done some googling and found templates for software design at high and low level. The problem is that all of the templates seem to be geared towards a complete system design as opposed to individual components and are consequently overkill.

Can anyone please point me in the direction of a template geared towards component documentation?

Many thanks

© Stack Overflow or respective owner

Related posts about c#

.NET WebRequest.PreAuthenticate not quite what it sounds like

as seen on West-Wind - Search for 'West-Wind'
I’ve run into the problem a few times now: How to pre-authenticate .NET WebRequest calls doing an HTTP call to the server – essentially send authentication credentials on the very first request instead of waiting for a server challenge first? At first glance this sound like it should be easy:… >>> More
HttpWebRequest and Ignoring SSL Certificate Errors

as seen on West-Wind - Search for 'West-Wind'
Man I can't believe this. I'm still mucking around with OFX servers and it drives me absolutely crazy how some these servers are just so unbelievably misconfigured. I've recently hit three different 3 major brokerages which fail HTTP validation with bad or corrupt certificates at least according to… >>> More
Dynamic Type to do away with Reflection

as seen on West-Wind - Search for 'West-Wind'
The dynamic type in C# 4.0 is a welcome addition to the language. One thing I’ve been doing a lot with it is to remove explicit Reflection code that’s often necessary when you ‘dynamically’ need to walk and object hierarchy. In the past I’ve had a number of ReflectionUtils that used string based expressions… >>> More
The dynamic Type in C# Simplifies COM Member Access from Visual FoxPro

as seen on West-Wind - Search for 'West-Wind'
I’ve written quite a bit about Visual FoxPro interoperating with .NET in the past both for ASP.NET interacting with Visual FoxPro COM objects as well as Visual FoxPro calling into .NET code via COM Interop. COM Interop with Visual FoxPro has a number of problems but one of them at least got a lot… >>> More
Finding a Relative Path in .NET

as seen on West-Wind - Search for 'West-Wind'
Here’s a nice and simple path utility that I’ve needed in a number of applications: I need to find a relative path based on a base path. So if I’m working in a folder called c:\temp\templates\ and I want to find a relative path for c:\temp\templates\subdir\test.txt I want to receive back subdir\test… >>> More

Related posts about component

What Every Developer Should Know About MSI Components

as seen on Geeks with Blogs - Search for 'Geeks with Blogs'
Hopefully nothing. But if you have to do more than simple XCopy deployment and you need to support updates, upgrades and perhaps side by side scenarios there is no way around MSI. You can create Msi files with a Visual Studio Setup project which is severely limited or you can use the Windows Installer… >>> More
Seems doctrine listener is not fired

as seen on Stack Overflow - Search for 'Stack Overflow'
Got a service which should be executed the moment an object is persisted. Though, I think the code looks like it should work, it doesn't. I configured the service like the following yml. services: bla_orm.listener: class: Bla\OrmBundle\EventListener\UserManager arguments:… >>> More
Box2D Joints in entity components system

as seen on Game Development - Search for 'Game Development'
I search a way to have Box2D joints in an entity component system, here is what i found : 1) Having the joints in Box2D/Body component as parameters, we have a joint array with an ID by joint and having in the other body component the same joint ID, like in this example : Entity1 - Box2D/Body component… >>> More
JSF - Unhide jsf component when clicking another component.

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I'm trying to have a button that brings up an upload dialog. The way i'm trying to achieve this is similar to this: <h:outputText value="Click Me" id="testit"> <a4j:support reRender="hideme" event="onclick" action="#{actions.switchTestRendered}"/> </h:outputText> <h:outputText… >>> More
Java DnD - Java Component to .Net Component

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm trying to use Java drag and drop to drag an object from a JTree into a native .NET component that is embedded in my app. This .NET component only accepts File objects, so I'm having trouble with the DnD's Transferable object. Anyone know how I can make this Transferable "look" like a file to… >>> More