CodeCommentInsert

Add comments to code

Chat Example

Programmatic Access

LLMResourceFunction["CodeCommentInsert"]["code"]

adds comments to the given code.

Details

This will work for most languages.

Examples

Comment a small, but complicated piece of Wolfram Language code:

In[1]:=

LLMResourceFunction["CodeCommentInsert"]["Reap[NestWhile[(Sow[#]/2)&,123456,EvenQ]]"]

Out[1]=

(* The code is written in Wolfram Language *)(* Reap is a function that collects all the values sown by Sow *)(* NestWhile is a function that repeatedly applies a function to an initial value until a condition is no longer satisfied *)Reap[ NestWhile[ (Sow[#]/2)&, (* Divide the current value by 2 and sow it *) 123456, (* Initial value *) EvenQ (* Continue iterating while the value is even *) ]]

Scope
(2)

Insert comments into a block of functional code:

In[1]:=

LLMResourceFunction["CodeCommentInsert"]["LLMPrompt[args___]:=With[{res=llmPrompt[args]},If[FailureQ[res],$Failed,res]](*One argument*)llmPrompt[HoldPattern[ro_ResourceObject],OptionsPattern[LLMPrompt]]:=Enclose[ConfirmAssert[ro[\"ResourceType\"]===\"Prompt\",Message[LLMPrompt::rtype]];Confirm[ro[\"PromptTemplate\"]]]llmPrompt[name_String,rest___]:=llmPrompt[\"Prompt\"->name,rest]/;!StringStartsQ[name,\"Prompt:\"]llmPrompt[HoldPattern[LLMFunction][HoldPattern[template_TemplateObject],___]]:=templatellmPrompt[HoldPattern[template_TemplateObject]]:=templatellmPrompt[expr_,params___,opts:OptionsPattern[LLMPrompt]]:=Enclose[Needs[\"PromptResource`\"->None];With[{ro=ConfirmBy[ResourceObject[expr,FilterRules[Flatten@{opts},Options[ResourceObject]]],ResourceSystemClient`ResourceObjectQ]},llmPrompt[ro,params,opts]]]llmPrompt[HoldPattern[ro_ResourceObject],params_,OptionsPattern[LLMPrompt]]:=Enclose[ConfirmAssert[ro[\"ResourceType\"]===\"Prompt\",Message[LLMPrompt::rtype]];llmc`TemplateApplyToTemplate[Confirm[ro[\"PromptTemplate\"]],params]]llmPrompt[template:HoldPattern[_LLMFunction|_LLMExampleFunction|_TemplateObject],params_,OptionsPattern[LLMPrompt]]:=Enclose[With[{to=ConfirmMatch[llmPrompt[template],_TemplateObject]},llmc`TemplateApplyToTemplate[to,params]]]llmPrompt[args___]:=Message[LLMPrompt::argt,LLMPrompt,Length[{args}],1,2]"]

Out[1]=

(* Language: Wolfram Language *)(* Define a function named LLMPrompt with one argument *)LLMPrompt[args___]:=With[{res=llmPrompt[args]},If[FailureQ[res],$Failed,res]](* Define a function named llmPrompt with a pattern for a ResourceObject and options *)llmPrompt[HoldPattern[ro_ResourceObject],OptionsPattern[LLMPrompt]]:=Enclose[ConfirmAssert[ro["ResourceType"]==="Prompt",Message[LLMPrompt::rtype]];Confirm[ro["PromptTemplate"]]](* Define a function named llmPrompt with a string argument and additional arguments *)llmPrompt[name_String,rest___]:=llmPrompt["Prompt"->name,rest]/;!StringStartsQ[name,"Prompt:"](* Define a function named llmPrompt with a pattern for a TemplateObject and additional arguments *)llmPrompt[HoldPattern[LLMFunction][HoldPattern[template_TemplateObject],___]]:=template(* Define a function named llmPrompt with a pattern for a TemplateObject *)llmPrompt[HoldPattern[template_TemplateObject]]:=template(* Define a function named llmPrompt with an expression, parameters, and options *)llmPrompt[expr_,params___,opts:OptionsPattern[LLMPrompt]]:=Enclose[Needs["PromptResourceResourceObjectQ]},llmPrompt[ro,params,opts]]](* Define a function named llmPrompt with a pattern for a ResourceObject, parameters, and options *)llmPrompt[HoldPattern[ro_ResourceObject],params_,OptionsPattern[LLMPrompt]]:=Enclose[ConfirmAssert[ro["ResourceType"]==="Prompt",Message[LLMPrompt::rtype]];llmcTemplateApplyToTemplate[to,params]]](* Define a function named llmPrompt with any arguments *)llmPrompt[args___]:=Message[LLMPrompt::argt,LLMPrompt,Length[{args}],1,2]

Insert comments into more procedural code:

In[2]:=

LLMResourceFunction["CodeCommentInsert"]"Module[{eq,iv,ov,carray,newinvars},iv=Complement[Select[Flatten[invars],(!FreeQ[equation,#])&],Flatten[outvars]];ov=Select[Flatten[outvars],(!FreeQ[equation,#])&];If[emptyQ[iv]||emptyQ[ov],Message[SystemsConnectionsModel::badeq,equation];Throw[$Failed]];eq=Solve[equation,iv];If[Head[eq]===Solve||emptyQ[eq],Message[SystemsConnectionsModel::badeq,equation];Throw[$Failed]];eq=iv/.First[eq];If[Length[iv]===1&&Length[ov]===1&&eq===ov, Return[{{DirectedEdge[name2index[ov[[1]],outvars,autoVarQ],name2index[iv[[1]],invars,autoVarQ]]},{},{}}]];carray=CoefficientArrays[eq,ov];If[!zeroQ[carray[[1]]]&&Length[carray]==2, Message[SystemsConnectionsModel::badeq,equation];Throw[$Failed] ];carray=Normal[Normal[carray[[2]]]];newinvars=Table[Automatic,{Length[ov]}];MapIndexed[If[MatchQ[#1,{___?zeroQ,1|1.,___?zeroQ}],newinvars[[First[Position[#1,1,{1},1]]]]=iv[[#2[[1]]]],nothing]&,carray];{MapIndexed[DirectedEdge[name2index[#,outvars,autoVarQ],{nsys+1,#2[[1]]}]&,ov],MapIndexed[DirectedEdge[{nsys+1,#2[[1]]},name2index[#,invars,autoVarQ]]&,iv],ConnectionBlock[carray,newinvars],Reverse@Dimensions[carray]}]"

Out[2]=

Module[{eq, iv, ov, carray, newinvars}, iv = Complement[Select[Flatten[invars], (!FreeQ[equation, #]) &], Flatten[outvars]]; (* Select input variables that appear in the equation *) ov = Select[Flatten[outvars], (!FreeQ[equation, #]) &]; (* Select output variables that appear in the equation *) If[emptyQ[iv] || emptyQ[ov], Message[SystemsConnectionsModel::badeq, equation]; Throw[$Failed]]; (* Check if input or output variables are empty *) eq = Solve[equation, iv]; (* Solve the equation for the input variables *) If[Head[eq] === Solve || emptyQ[eq], Message[SystemsConnectionsModel::badeq, equation]; Throw[$Failed]]; (* Check if the equation is solvable *) eq = iv /. First[eq]; (* Assign the solved values to the input variables *) If[Length[iv] === 1 && Length[ov] === 1 && eq === ov, Return[{{DirectedEdge[name2index[ov[[1]], outvars, autoVarQ], name2index[iv[[1]], invars, autoVarQ]]}, {}, {}}]]; (* Check if there is a direct connection between input and output variables *) carray = CoefficientArrays[eq, ov]; (* Get the coefficient arrays of the equation *) If[!zeroQ[carray[[1]]] && Length[carray] == 2, Message[SystemsConnectionsModel::badeq, equation]; Throw[$Failed]]; (* Check if the equation is valid *) carray = Normal[Normal[carray[[2]]]]; (* Convert the coefficient arrays to normal form *) newinvars = Table[Automatic, {Length[ov]}]; (* Create a new list of input variables *) MapIndexed[If[MatchQ[#1, {___?zeroQ, 1 | 1., ___?zeroQ}], newinvars[[First[Position[#1, 1, {1}, 1]]]] = iv[[#2[[1]]]], nothing] &, carray]; (* Map the solved input variables to the new list *) {MapIndexed[DirectedEdge[name2index[#, outvars, autoVarQ], {nsys + 1, #2[[1]]}] &, ov], (* Create directed edges from output variables to the next system *) MapIndexed[DirectedEdge[{nsys + 1, #2[[1]]}, name2index[#, invars, autoVarQ]] &, iv], (* Create directed edges from the next system to input variables *) ConnectionBlock[carray, newinvars], Reverse@Dimensions[carray]}] (* Create the connection block and return the result *)

Prompt Source

Definition Notebook »

Publisher Information

Contributed by: Bob Sandheinrich

Wolfram Prompt Repository(Under Construction)

CodeCommentInsert

Chat Example

Programmatic Access

Details

Examples

Scope
(2)

Prompt Source

See Also

Publisher Information

CodeCommentInsert

Chat Example

Programmatic Access

Details

Examples

Scope (2)

Prompt Source

See Also

Publisher Information

Scope
(2)