# headcomments

Display Nelson function header comments.

## Syntax

* headcomments(function\_name)
* ce = headcomments(function\_name)

## Input argument

* function\_name - a string: function name or a .m filename.

## Output argument

* ce - a cell of strings

## Description

**head\_comments** displays the function header comments.

Comments are read from the associated .m file.

Nelson predefined functions have no header comments.

## Example

```matlab
comments = headcomments('cellstr'); md = markdown(comments);inserthtml(md)
```

![](https://160667757-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LdPvJ6mJve3gz5MU4d1%2Fsync%2F88afe874765a0af0d81658d4f4d38abacf7c34ea.png?generation=1590311958595080\&alt=media)

## See also

[doc](../help_browser/doc), [markdown](markdown), [inserthtml](../gui/inserthtml), [which](https://github.com/Nelson-numerical-software/nelson-gitbook/blob/master/en/help_tools/which.html).

## History

| Version | Description     |
| ------- | --------------- |
| 1.0.0   | initial version |

## Author

Allan CORNET
