# Argument-specific docstrings or comments

**URL:** <https://discourse.julialang.org/t/argument-specific-docstrings-or-comments/32189>\
**Category:** Internals & Design\
**Created:** [December 12, 2019, 11:37am UTC](https://discourse.julialang.org/t/argument-specific-docstrings-or-comments/32189 "2019-12-12T11:37:02Z")\
**Posts on this page:** 1\
**Showing post:** 15

<div class="post-metadata">

**Author:** ![MartinOtter](https://avatars.discourse-cdn.com/v4/letter/m/87869e/32.png) [@MartinOtter](https://discourse.julialang.org/u/MartinOtter)\
**Post date:** [December 13, 2019, 2:57pm UTC](https://discourse.julialang.org/t/argument-specific-docstrings-or-comments/32189/15 "2019-12-13T14:57:31Z")

</div>

Note, this approach is used in the Modelica modelling language since year 2000. In Modelica, it is more general: A description string can be added after every function definition, after every function argument and before every “;” of a statement/equation . There are then report generators that generate a pretty-print version, e.g. a list of all functions with just the function name and the description string; or a function with the input/output arguments in a table with description strings. Example:

![image](https://global.discourse-cdn.com/julialang/original/3X/0/1/016504a48134c7e0e181cc0f3f86354bcb04a556.png)

Furthermore, tools provide the possibilty to pop-up an automatically generate GUI from the given information so that the arguments of the function can be given in this GUI and by clicking a button, the function is executed with the arguments provided in the GUI. Example:

![image](https://global.discourse-cdn.com/julialang/original/3X/7/6/76222c003f45d9d7e0d9bd603926849fc3201ca7.png)

---

_[View the full topic](https://discourse.julialang.org/t/argument-specific-docstrings-or-comments/32189)._
