Hello everyone,
There are special tags in C# that can be used above every method to put commments within and later on, generating a documentation for your code thankfully documentation’s compilers (one example of this compilers for C# is Sandcastle). I’ve whatched this special tags in Java but not in C#. I’ve found C# example code with this tags but I don’t like the way the author structured them. This isn’t ‘clean-code’ for me.
I’d like to know if they are ok for the compiler structuring them in other way. I’ve not setup the tools for generate documentation so I can’t test it my self yet. Thanks.
This is the example code that I don’t like:
/// <summary>
//Constructor with adding position to the node creation
/// </summary>
public Node(Vector3 pos)
{
}
I prefer this way:
/// <summary>Constructor with adding position to the node creation</summary>
public Node(Vector3 pos)
{
}