I have my libraries. How do I promote them?
Considering you have made all the necessary effort to guarantee you have good libraries that can be reused in many of your projects, you will find another difficult situation arises when enabling reusability: it is not simple to let programmers know you have libraries ready to reuse.
There are some simple approaches to documenting a library. As we mentioned when we talked about the development life cycle, documenting is a good way to help developers take notice of the libraries they have. There are two examples of documenting reusable code that we would like to mention here.
Documenting .NET libraries using DocFX
This tool is a good alternative for documenting a library using comments made in its code. By simply adding the NuGet package docfx.console
, the tool allows you to create a task that will run once your library has been built:
Figure 12.5: docfx.console NuGet library
The output of this compilation is a stylish...