AnnotationType Module
Overview
The AnnotationType module provides an enumeration of annotations that can be used in template design files with the .pymd extension.
Module: pymaidol
Import
from pymaidol import AnnotationType
Classes
Static Variables
| Name | Type | Description |
|---|
| FULL_ANNOTATION_TYPE | list[AnnotationTypeEnum] | A list that contains all the enumeration values of the annotation type enumerations. |
1 - AnnotationTypeEnum Enumeration
Overview
The AnnotationTypeEnum enumeration is the base class for all annotation type enumerations. It has no internal enumeration values and is only used for inheritance.
Module: pymaidol.AnnotationType
Inherits from: enum.Enum
Import
from pymaidol import AnnotationTypeEnum
or
from pymaidol.AnnotationType import AnnotationTypeEnum
2 - MultiLineAnnotationTypeEnum Enumeration
Overview
Contains the types of multiline annotations that can be used in template design files .pymd.
Module: pymaidol.AnnotationType
Inherits from: pymaidol.AnnotationType.AnnotationTypeEnum
Import
from pymaidol import MultiLineAnnotationTypeEnum
or
from pymaidol.AnnotationType import MultiLineAnnotationTypeEnum
Enum Items
| Name | Value | Description |
|---|
| Python | ’'' | Multiline comment in Python, which starts and ends with '''. |
| C | /* | Multiline comment in C, which starts with /\* and ends with */. |
| HTML | <!– | Multiline comment in HTML, which starts with <!-- and ends with -->. |
3 - SingleLineAnnotationTypeEnum Enumeration
Overview
Contains the types of single-line annotations that can be used in template design files .pymd.
Module: pymaidol.AnnotationType
Inherits from: pymaidol.AnnotationType.AnnotationTypeEnum
Import
from pymaidol import SingleLineAnnotationTypeEnum
or
from pymaidol.AnnotationType import SingleLineAnnotationTypeEnum
Enum Items
| Name | Value | Description |
|---|
| Python | # | Single-line comment for Python, which starts with #. |
| C | // | Single-line comment for C, which starts with //. |
See Also
AnnotationTypeEnum Enumeration