Have you seen how javadoc generated documentation will look like ?, if not see here

Visual studio.NET IDE have also got a beautiful source code documentation generation tool
For C# , the simple syntax for writing the documentation(lets say for a method called getName...

	/// <summary>
	/// Gets name for the given categeory id
	/// </summary>
	/// <param name="catID">string based catID ....blah blah..
	/// <returns>returns category Name as string</returns>
	public string getUserProfile(string catID)
	{
	...
	}

	'<

	'Gets name for the given categeory id
	'</summary>
	'<remarks />
	Function getUserProfile(Dim catID as String) as String

	...
	End Function