Get XML Comments Path for documenting ASP.NET Web API

One common tasks for many projects is documenting their ASP.NET Web API projects using the Xml Comments in the project.

However, the default code in Web API does not know how to locate the Xml Comments file, so you have to write this custom code yourself!

You can easily add this code to your Web API by using the following code snippet:

	/// <summary>
	/// Gets the path to the Xml Comments file for the Web API assembly
	/// </summary>
	/// <returns></returns>
	private static string GetXmlCommentsPath()
	{
	var baseDirectory = AppDomain.CurrentDomain.BaseDirectory;
	var commentsFileName = string.Format("{0}.XML", Assembly.GetExecutingAssembly().GetName().Name);
	var binFilePath = Path.Combine(baseDirectory, "bin");
	var commentsFilePath = Path.Combine(binFilePath, commentsFileName);
	return commentsFilePath;
	}

view raw GetXmlCommentsPath.cs hosted with ❤ by GitHub