Is there a FAQ sheet to properly ask a question and display code?

Just curious, since I decided to ask my first question last night, and the exercise took more than two hours to complete. The struggle occurred when my question exceeded the character count along with a few extraneous characters within my code.

I refactored my question and code to shoehorn the question within the character count. I read the overview, which stated how I should present my question, et al, but loading the code was interesting, since my code contained comments with a few apostrophes, causing the code to be improperly displayed. (That was fun to try and decipher.) A continuous exercise in "Pete" and "Re-Pete" to find the offending character ... :]

That said, a user FAQ sheet for all beginners would be a nice feature to illustrate the proper way to present readable code, and to identify the character limit, before one begins to ask a question.

Just a thought ...

Best regards,

jim k








Answered by DTS Engineer in 676024022
What Claude31 said but also…

a user FAQ sheet for all beginners would be a nice feature

A good place to start is Apple Developer > Support > Developer Forums. On the subject of formatting it says:

Formatting


You can format your posts using a Markdown-like editor.
Most developers are familiar with Markdown because it’s used in a wide range of development situations. For more background, see The Fount of All Knowledge™.

Note that DevForums does not support all Markdown syntax, but that coverage is steadily improving over time.

Share and Enjoy

Quinn “The Eskimo!” @ Developer Technical Support @ Apple
let myEmail = "eskimo" + "1" + "@" + "apple.com"
If you want to post code:
  • if short enough, use the code formatter tool (<>) for better presentation and line numbering.

  • Also paste as "Paste and match Style", to avoid the editor adding a lot of empty lines.

  • if the code is longer, use text attachment (paper clip icon on the right): click icon and paste code.

like this from : Apple Inc. « The Swift Programming Language (Swift 4). » Apple Books.


Accepted Answer
What Claude31 said but also…

a user FAQ sheet for all beginners would be a nice feature

A good place to start is Apple Developer > Support > Developer Forums. On the subject of formatting it says:

Formatting


You can format your posts using a Markdown-like editor.
Most developers are familiar with Markdown because it’s used in a wide range of development situations. For more background, see The Fount of All Knowledge™.

Note that DevForums does not support all Markdown syntax, but that coverage is steadily improving over time.

Share and Enjoy

Quinn “The Eskimo!” @ Developer Technical Support @ Apple
let myEmail = "eskimo" + "1" + "@" + "apple.com"

Gentlemen, thank you for the updated information ... :] It was fun trying to navigate with my first attempt, but successful.

I shall generate more questions about Swift in the future, once I understand how to ask the right question, since Swift is new to me, but not coding. Again, thank you.

Best regards,

jim k

Is there a FAQ sheet to properly ask a question and display code?
 
 
Q