Commentaires

Forum destiné aux questions et discussions en français
Forum rules
Be nice to others! Read the FreeCAD code of conduct!
User avatar
multitrain
Posts: 125
Joined: Sun May 31, 2020 5:13 pm

Commentaires

Post by multitrain »

Bonjour,

Vu la richesse des outils, quand je regarde le descriptif d'un objet que j’ai réalisé, bien souvent je ne sais plus comment et avec quel outil j'ai fait certaines actions. Y aurait il la possibilité d'ajouter des commentaires dans cette fenêtre afin de reprendre rapidement le fil conducteur de la réalisation.

J’écris aussi des programmes pour micro contrôleurs et en général, il y plus de lignes de commentaires que de lignes d'instructions....
Sans cela l'évolution ou la modification pour une application légèrement différente deviendrait quasiment un nouveau programme avec tous les tests afférents.

Patrick
User avatar
Jimidi
Posts: 535
Joined: Wed Jul 26, 2017 3:53 pm

Re: Commentaires

Post by Jimidi »

Bonjour,

multitrain wrote: Thu Jun 25, 2020 6:35 am ...
Y aurait il la possibilité d'ajouter des commentaires dans cette fenêtre afin de reprendre rapidement le fil conducteur de la réalisation.
...

Hello Patrick, je pense que le plus simple reste de nommer précisément les fonctions et objets dans l'arborescence (touche F2) Si peu que l'on se donne la peine en sus de numéroter ces étapes, le concept de réalisation devient très clair à comprendre plus tard lorsque l'on visualise et décortique un fichier dont on a oublié comment on s'y était pris.
Voici pour exemple une réédition d'illustration que j'avais publiée ici même et à destination de compréhension justement, genre tutoriel. En lisant simplement l'arborescence à gauche dans l'ordre des étapes numérotées, tout devient lumineux.



2 empreintes hélicoïdales à tangence parfaite sur cylindre atelier CurvesWB.jpg
2 empreintes hélicoïdales à tangence parfaite sur cylindre atelier CurvesWB.jpg (721.37 KiB) Viewed 1522 times

Salutations, Jean-Michel
User avatar
Vincent B
Veteran
Posts: 4713
Joined: Sun Apr 05, 2015 9:02 am
Location: La Rochelle, France

Re: Commentaires

Post by Vincent B »

Une nouvelle fonction est apparue récemment: label2.
En cliquant à droite dans l'onglet paramètres, on a "show all", puis accès à label2.
une solution pour documenter son dessin. ;)
Attachments
Capture.JPG
Capture.JPG (59.3 KiB) Viewed 1474 times
User avatar
Vincent B
Veteran
Posts: 4713
Joined: Sun Apr 05, 2015 9:02 am
Location: La Rochelle, France

Re: Commentaires

Post by Vincent B »

Dans "tools" ou "outils" on a aussi une nouvelle fonction "add document text". Ça peut être utile également. ;)
Attachments
Capture.JPG
Capture.JPG (35.13 KiB) Viewed 1473 times
User avatar
-alex-
Veteran
Posts: 1856
Joined: Wed Feb 13, 2019 9:42 pm
Location: France

Re: Commentaires

Post by -alex- »

Tu peux également mettre des commentaires dans Fichier -> Informations sur le projet -> Commentaires.
Bien des façons de commenter en somme :)
User avatar
multitrain
Posts: 125
Joined: Sun May 31, 2020 5:13 pm

Re: Commentaires

Post by multitrain »

Merci à tous,

Alex: Je ne connaissais pas le commentaire global sur le projet qui permet d’enregistrer des informations, le pourquoi et le comment, c'est une excellente solution globale. Mais ce n'est pas suffisant pour commenter chaque action.

GlouGlou: La version 0.18 n'a pas cette possibilité de label2, peut être la 0.19 permet cet ajout. A propos, comment charger la 0.19, les liens de téléchargement de cette version renvoi sur le téléchargement de la 0.18
https://wiki.freecadweb.org/Release_notes_0.19/fr
FreeCAD 0.19 a été publié le DD mois 2020, il est disponible sur la page de téléchargement.

Patrick
david69
Veteran
Posts: 1773
Joined: Wed Jan 01, 2014 7:48 pm

Re: Commentaires

Post by david69 »

tu as trouve la bonne page du wiki et sur cette meme page tu as:
- Version stable courante
- Versions de développement
openBrain
Veteran
Posts: 9034
Joined: Fri Nov 09, 2018 5:38 pm
Contact:

Re: Commentaires

Post by openBrain »

Pour aider à documenter, il y a éventuellement Macro TreeToAscii/fr (un peu d'auto-promo ne nuit pas :D )
User avatar
Forthman
Veteran
Posts: 2650
Joined: Fri Apr 27, 2018 11:23 am
Location: Tarn-et-Garonne (82)

Re: Commentaires

Post by Forthman »

Même sans la présence de Label2, on peut mettre le commentaire que l'on veut sur Label1. ;)
mario52
Veteran
Posts: 4673
Joined: Wed May 16, 2012 2:13 pm

Re: Commentaires

Post by mario52 »

Bonjour
openBrain wrote: Fri Jun 26, 2020 3:19 pm (un peu d'auto-promo ne nuit pas :D )
+1

avec la macro Macro_PropertyMemo vous pouvez ajouter un mémo ou un texte explicatif sur chaque objet du document

Image

mario
Maybe you need a special feature, go into Macros_recipes and Code_snippets, Topological_data_scripting.
My macros on Gist.github here complete macros Wiki and forum.
Post Reply