CAM Comment: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Path->CAM)
 
(20 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:8-->
<!--T:8-->
{{Docnav
{{Docnav|[[Path_Fixture|Fixture]]|[[Path_Stop|Stop]]|[[Path_Workbench|Path]]|IconL=Path_Fixture.png|IconC=Path-Workbench.svg|IconR=Path_Stop.png}}
|[[CAM_Fixture|Fixture]]
|[[CAM_Stop|Stop]]
|[[CAM_Workbench|CAM]]
|IconL=CAM_Fixture.svg
|IconR=CAM_Stop.svg
|IconC=Workbench_CAM.svg
}}


<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand|Name=Path Comment|Workbenches=[[Path Workbench|Path]]|MenuLocation=Path → Partial Commands → Comment|Shortcut=P,C|SeeAlso=}}
|Name=CAM Comment
|MenuLocation=CAM → Supplemental Commands → Comment
|Workbenches=[[CAM_Workbench|CAM]]
}}


==Description== <!--T:2-->
==Description== <!--T:2-->


<!--T:3-->
<!--T:3-->
This tool inserts a comment. When exporting a project to G-code, the comments will be inserted in the G-code program, and can be read by people reading the file. Some machine controllers will also display comments on their display screens.
The tool [[Image:CAM_Comment.svg|24px]] [[CAM_Comment|Comment]] inserts a comment. When exporting a project to G-code, the comments will be inserted in the G-code program, and can be read by people reading the file. Some machine controllers will also display comments on their display screens.


==Usage== <!--T:4-->
==Usage== <!--T:4-->


<!--T:5-->
<!--T:5-->
# Press the {{KEY|[[Image:Path Comment.png|16px]] [[Path Comment|Comment]]}} button
# Press the {{KEY|[[Image:CAM_Comment.svg|16px]] [[CAM_Comment|Comment]]}} button or use the {{KEY|P}} then {{KEY|C}} keyboard shortcut.
# Write your comment in the '''Comment''' property
# Write your comment in the '''Comment''' property


Line 23: Line 35:
* {{PropertyData|Comment}}: The text of your comment
* {{PropertyData|Comment}}: The text of your comment


==Scripting== <!--T:14-->


<!--T:12-->
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


<!--T:9-->
<!--T:13-->
Example:
{{Docnav|[[Path_Fixture|Fixture]]|[[Path_Stop|Stop]]|[[Path_Workbench|Path]]|IconL=Path_Fixture.png|IconC=Path-Workbench.svg|IconR=Path_Stop.png}}


</translate>
<!--T:10-->
{{Code|code=
{{Path_Tools_navi}}
#Place code example here.
}}
<translate>



<!--T:11-->
<!--T:9-->
{{Userdocnavi}}
{{Docnav
|[[CAM_Fixture|Fixture]]
|[[CAM_Stop|Stop]]
|[[CAM_Workbench|CAM]]
|IconL=CAM_Fixture.svg
|IconR=CAM_Stop.svg
|IconC=Workbench_CAM.svg
}}


</translate>
</translate>
{{CAM_Tools_navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 21:36, 16 March 2024

CAM Comment

Menu location
CAM → Supplemental Commands → Comment
Workbenches
CAM
Default shortcut
None
Introduced in version
-
See also
None

Description

The tool Comment inserts a comment. When exporting a project to G-code, the comments will be inserted in the G-code program, and can be read by people reading the file. Some machine controllers will also display comments on their display screens.

Usage

  1. Press the Comment button or use the P then C keyboard shortcut.
  2. Write your comment in the Comment property

Properties

  • DataComment: The text of your comment

Scripting

See also: FreeCAD Scripting Basics.

Example:

#Place code example here.