Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-19 16:13:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: fix markdown errors and update

Browse Source
This commit is contained in:
Rainer Killinger
2020-10-30 17:45:49 +01:00
parent 5f34bc900c
commit ccb1b56a0f
8 changed files with 29 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
project-docs/workflow/DOCUMENTATION.md
View File

@@ -1,6 +1,6 @@
# Documentation
Every projects need a `README.md` as a standardized entry of information about the scope of a [project](PROJECT.md) and how to install and execute it.
Every projects need a `README.md` as a standardized entry of information about the scope of a [project](PROJECT.md) and how to install and execute it.
## Inline (code) documentation
@@ -10,7 +10,7 @@ Code is annotated with [TypeDoc](https://typedoc.org/), which then can be used t
Please follow these guidelines to reduce redundance:
* The purpose of inline documentation is to explain what the line of code actually does without explaining syntax or external references. Example:
* The purpose of inline documentation is to explain what the line of code actually does without explaining syntax or external references. Example:
```typescript
// extend the template by the properties of the base template
@@ -36,10 +36,12 @@ async get<T>(key: string): Promise<T> {
return entry;
}
```
### Inline Comments `//`
* Start inline comments with a lowercase letter and a space after the `//`
* Place the comment above the line that it is referencing
```typescript
// lorem ipsum
const lorem;
@@ -55,10 +57,11 @@ const lorem;
* Document all parameters in functions using `@param`
* `@param` must not contain a type annotation, just `@param name description`
* Do not include `@return`, as it is redundant information
```typescript
/**
* Short summary of the function, without a period
*
*
* This is a very long description, that could never possibly fit on one line, nor could it
* be read in a short amount of time. Because we can use multiple sentences here, we can actually
* use a period.
@@ -70,7 +73,7 @@ function fun(foo: number): Foo {
## `CONTRIBUTING.md`
Every project can have a `CONTRIBUTING.md` which explains how to contribute to the project either just by issues or code contributions.
Every project can have a `CONTRIBUTING.md` which explains how to contribute to the project either just by issues or code contributions.
## Issue templates