Naming rules for struct/class/bus
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- matlab
- Domaine
- documentation
Piste de recherche
Commencez par lire les recommandations existantes « Defining structs » ainsi que les directives de nommage de Model Advisor référencées dans l’issue. Comparez les conventions applicables aux champs de struct et de class dans MATLAB avec les éléments de Simulink.Bus, puis documentez une recommandation cohérente qui résout l’incohérence de nommage décrite entre bus et MATLAB Function.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
I noticed there isn’t yet an explicit guideline for struct names and, in particular, for struct field names. The only related reference I found, “Defining structs”, includes an example where the struct members use UpperCamelCase. Should these be UpperCamelCase? And if so, should the same convention apply to Simulink.Bus elements?
I’m asking because this can create a mismatch with some Model Advisor naming guidelines. For example, suppose I have a Simulink Inport of type Bus, with elements Signal1 and Signal2, which has been created from a MATLAB struct or class. If I use a Bus Selector to extract Signal1 and feed it into a MATLAB Function block, where the corresponding function parameter is named signal1 (lowerCamelCase, following MATLAB function parameter conventions), Model Advisor will trigger a violation because the bus element name (UpperCamelCase) doesn’t match the block input name (lowerCamelCase).
Is there any recommendations on how to harmonize these conventions?
- Langage dominant
- Aucune donnée de langage
- Étoiles
- 142
- Forks
- 11
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de mathworks/MATLAB-Coding-Guidelines
-
linking issuePeut-être à nouveau libre @dgarriso l’a pris il y a 146 jours, et aucune pull request n’est ouverte. Ouvertebug
mathworks/MATLAB-Coding-Guidelines#5 · 1 commentaire · 1 personne assignée ·
Toutes les issues de mathworks/MATLAB-Coding-Guidelines
Issues similaires
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
philchalmers/SimDesign#106 ·
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Small-tailqwq/dsh-deep-whale#187 ·
Les mainteneurs répondent en général sous 1 jour
-
audit.md numbers Theming and Responsive Design differently in the headings and the score tablePeut-être pris @pbakaus l’a pris aujourd’hui. Ouverteneeds triage
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
pbakaus/impeccable#979 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
-
documentation
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
fastrevmd-lab/rustmistmcp#161 ·