Example Naming Convention

Dear Sir/Mam,

I want a clarification regarding coding my current approved book.

In the book approved, there are four "Examples" in "Part 0" "Chapter 3". The names of the examples are "Example A" ,"Example B" "Example A" and" "Example B", under different headings, of course.

My doubt is what should the naming convention be? Should it be -

1. Ex3_A1, Ex3_B1, Ex3_A2, Ex3_B2 in .sce format and mention clarification in comment or

2. Ex3_1, Ex3_2, Ex3_3, Ex3_4 in .sce format and mention clarification in comment or

3. something else.

Please Help....

Scilab 30-01-19, 8:20 p.m. Parmanand_Mishra

Naming convention should be as follows :
For chapter 3/Part 0 = Ex3_1
In same .sci file, do coding for all the subparts, but do not forget to mention the different headings for different subparts as comments.

01-02-19, 11:02 a.m. Rashmi
The examples are four seperate examples.  should i code them all in one code??

01-02-19, 12:01 p.m. Parmanand_Mishra
Part 0 is for the book, not for ch3. There are 5 chapters in part 0 of the book, one of which is chapter 3.

01-02-19, 12:05 p.m. Parmanand_Mishra

Login to add comment


Yes, code them all in one single file. But as I said, for different subparts, give different headings.

01-02-19, 12:12 p.m. Rashmi

Helpize the book code for the archive and search the book of information an easy. Books on the same topic will be conventions according to the same rules. io games
28-07-22, 1:28 p.m. alexusa0106

Yes, put the code for all of them in the same file. But, as I mentioned before, use distinct titles for each subsection. cookie clicker
13-12-22, 12:53 p.m. wilbert02

Hello, The naming convention you choose for your examples is ultimately up to you and your team. However, I can provide some suggestions based on common practices in the industry. One option could be to use a naming convention that includes the chapter and example number, such as "ch3_ex1", "ch3_ex2", "ch3_ex3", and "ch3_ex4". This way, it is easy to identify which chapter and example the code belongs to. Alternatively, you could use a naming convention that includes both the chapter and example name, such as "ch3_exA1", "ch3_exB1", "ch3_exA2", and "ch3_exB2". This would make it easier to identify which example the code belongs to, but may require more characters in the naming convention. Ultimately, it's important to choose a naming convention that makes sense to you and your team, and is consistent throughout the project. It's also a good idea to include comments in your code to clarify which example each piece of code belongs to. exhibit of sorrows
05-05-23, 12:58 p.m. emmaorabelle

When it comes to naming conventions for the examples in your book, there is no one-size-fits-all answer as it ultimately depends on your personal preference and the specific requirements of your book. Rainbow Friends: Chapter 2
08-06-23, 1:23 p.m. victorpatrick

It might be beneficial to include a clarification to your code's comments, like you mentioned. To clear up any misunderstandings, you might state autistic test that the naming scheme is "Ex3_A1, Ex3_B1, Ex3_A2, Ex3_B2".
30-06-23, 10:27 a.m. timothyferriss

Log-in to answer to this question.