Icon class icon_class far fa-sticky-note icon_class_computed far fa-sticky-note Note kind CONVENTION MODELLING NAMING Policy level INFORMATIVE UML keywords NamedElement::name NamedElement Property Action Port SysMLv1.x keywords "standard" Port block property part property reference property Keywords SysML SysPhS Systems Modeling Language Modelica Simulink Simscape Stateflow Webel Best Practice Relates to Related notes [NAMING, POLICY, STYLE] "Trust the Port or Pin Type!" - Often the name of the Type of an anonymous Port or Pin is completely sufficient to indicate its role, unless a clear indication of its direction or unique role is required. [CONVENTION, NAMING, STYLE]{STRONG} FlowProperty naming. Use anonymous or just 'i' for in, 'o' for out, and 'io' (or 'oi') for inout. "Trust the Type". For conjugation ~InterfaceBlock use 'o' for in, 'i' for out, and 'io' (or 'oi') for inout. [NAMING, POLICY]{STRONG} Prefer anonymous Actions, or if they must be named, prefer code-like 'lowerCamelCase' or completely 'lower case' (if you do absolutely insist on having spaces in action names, but please no other punctuation). [NAMING, POLICY]{STRICT} SysML: Naming: Always use either anonymous or first letter lower case for Property, ObjectNode and InstanceSpecification names; no exceptions (unless using names to "quote text")! Valid: 'lowerCamelCase' OR 'tla' vs TLA acronym OR 'uCC' vs UpperCamelCase [NAMING, POLICY, STYLE]{STRONG} SysML: Webel: "Trust the Type!" - Often the name of the Type of an anonymous Property or instance-level element is completely sufficient to indicate its role - unless multiple Properties of the same Type have different roles within the same owner context! Related notes (backlinks) Related snippets (extracts) Visit also Visit also (backlinks) Flags Book traversal links for SysML/SysPhS-1.1: Anonymous Property or Action names may not be an option if: You are exporting to Modelica or Simulink; You absolutely need names for generated query reports (such as generated Interface Control Documents). Previous Up Next