Project Databases: Build your own documentation for components

Automatically translated from English

In a previous blog post, we showed you that documentation for methods has returned in the Explorer. Want to take things even further and use them as documentation for your components? In this blog post, we’ll show you how!

Share source code and documentation

Sharing component sources with project databases is very easy (e.g., via GitHub). To explain how to use them, documentation is essential. The documentation in the Explorer is saved in Markdown files, so you can use it to create documentation for your components.

 

If you use GitHub, you can create a mini-site for your documentation. Simply create a README file with a link to each method’s documentation. Then in your repository settings, activate GitHub page.

 

Voilà!

README.md

getStartOfMonth.md

 

Compiled component AND DOCUMENTATION

When you build your component or compiled application with the “Build Application” dialog, the “Documentation” folder is automatically copied to the final project folder.

Project

Compiled component

When a developer integrates your component into their database, they can directly see the documentation in the Explorer in 4D.

Vanessa Talbot

• Product Owner •

Vanessa Talbot joined 4D Program team in June, 2014. As a Product Owner, she is in charge of writing the user stories then translating it to functional specifications. Her role is also to make sure that the feature implementation delivered is meeting the customer need.

Since her arrival, she has worked to define key features in 4D. She has worked on most of preemptive multi-threading new features and also on a very complex subject: the new architecture for engined application. Vanessa has a degree from Telecom Saint-Etienne. She began her career at the Criminal Research Institute as a developer for the audiovisual department. She has also worked in media and medical fields as expert in technical support, production as well as documenting new features.