Newbie question about ios code comments

posts by yangfanacc edited 2013-10-21 17:37:58

Ios arrived inside the company's learning and development, nothing really understand. Also are learning. But my colleagues today to see the project code, I found a very worried problem is that I do not understand. I am not not read the code, but I do not know his code is what does it mean. I do java, I used to use when writing java annotation but found no note here the day so sad. I do not know what notes inside ios no rules? We ask peers related to some good advice.
Reply:
Enter the result of accidentally pressed to settle down, and I found no way to modify to modify the score, I hope you will forgive me, but also want to be able to give some useful suggestions, Wan Xie,
Reply:
Can extra points, has been added,

cited a floor yangfanacc reply:

accidentally press the Enter result points to settle down, and I found no way to modify to modify the score, the I hope you will forgive me, but also want to be able to give some useful suggestions, Wan Xie,

can be a plus, has been added,
Reply:
iOS notes inside almost ah, "/ /" comment line "/ ** /" comment period, # param mark the contents of this note is generally used to segment, considered the role of the following methods to explain it
Others feel the difference is not great.
Reply:
Rarely comment - because the method names longer be able to see what this method is doing.
Notes format with other words there is no difference
Reply:

reference to the third floor yang8456211 reply:

iOS notes inside almost ah, "/ /" comment line "/ ** /" comment period, # param mark the contents of this note is generally used to segment, considered to explain the role of the following methods it
Others feel the difference is not great.

Ditto, # param mark explain multiple methods, / / ​​single method explained
Reply:
Obviously I do not like the answer, ah, I need a comment norms, for example, each class. M file is not required to explain the role of note, is not need to explain the usefulness of each method and whatwhatwhat so, expect answers
Reply:

reference to the 6th floor yangfanacc reply:

Obviously I do not like the answer, ah, I need a comment norms, for example, each class m. document is not required to explain the role of note, is not need to explain the usefulness of each method and whatwhatwhat so, expect answers,

X �n X. . . . . Comment this thing. . Eyes of the beholder wise see wisdom, ah, you want to write more clearly also, absolutely can not write. . .

But if you say the words specification, reference Apple's official demo, then
1) Project which has readMe.txt, this is mainly introductory comments, version updates, ah, and explain the use of some important classes.
2). H front and. M generally have a large segment of useless responsibility statement or something, some little simple introduction. Not focus comment About readMe methods are lost in it.
3) "/ /", then simply use the comment in place, use a more flexible
4) # param mark the beginning of the content used in a large segment of segmentation and the method used above. On such
# Param mark UITableViewDelegate
.....
# Param mark UITableViewDataSource
...

This explains the above paragraph is about UITableViewDelegate agent inside the method, and then UITableViewDataSource is another proxy slightly.

Comment this thing do not be entangled -. . . Because the code does not require too many good comments, one can understand it.


Reply:

reference to the 7th floor yang8456211 reply:

Quote: references to the 6th floor yangfanacc reply:

Obviously I do not like the answer, ah, I need a comment norms, for example, each class. M file is not required to explain the role of note, is not need to explain the usefulness of each method and whatwhatwhat so, expect answers

X �n X. . . . . Comment this thing. . Eyes of the beholder wise see wisdom, ah, you want to write more clearly also, absolutely can not write. . .

But if you say the words specification, reference Apple's official demo, then
1) Project which has readMe.txt, this is mainly introductory comments, version updates, ah, and explain the use of some important classes.
2). H front and. M generally have a large segment of useless responsibility statement or something, some little simple introduction. Not focus comment About readMe methods are lost in it.
3) "/ /", then simply use the comment in place, use a more flexible
4) # param mark the beginning of the content used in a large segment of segmentation and the method used above. On such
# Param mark UITableViewDelegate
.....
# Param mark UITableViewDataSource
...

This explains the above paragraph is about UITableViewDelegate agent inside the method, and then UITableViewDataSource is another proxy slightly.

Comment this thing do not be entangled -. . . Because the code does not require too many good comments, one can understand it.

Plus the best in front of a param mark -
Reply:

reference to the 7th floor yang8456211 reply:

Quote: references to the 6th floor yangfanacc reply:

Obviously I do not like the answer, ah, I need a comment norms, for example, each class. M file is not required to explain the role of note, is not need to explain the usefulness of each method and whatwhatwhat so, expect answers

X �n X. . . . . Comment this thing. . Eyes of the beholder wise see wisdom, ah, you want to write more clearly also, absolutely can not write. . .

But if you say the words specification, reference Apple's official demo, then
1) Project which has readMe.txt, this is mainly introductory comments, version updates, ah, and explain the use of some important classes.
2). H front and. M generally have a large segment of useless responsibility statement or something, some little simple introduction. Not focus comment About readMe methods are lost in it.
3) "/ /", then simply use the comment in place, use a more flexible
4) # param mark the beginning of the content used in a large segment of segmentation and the method used above. On such
# Param mark UITableViewDelegate
.....
# Param mark UITableViewDataSource
...

This explains the above paragraph is about UITableViewDelegate agent inside the method, and then UITableViewDataSource is another proxy slightly.

Comment this thing do not be entangled -. . . Because the code does not require too many good comments, one can understand it.

Thank you,
Reply:

reference to the 9th floor yangfanacc reply:

Quote: references to the 7th floor yang8456211 reply:

Quote: references to the 6th floor yangfanacc reply:

Obviously I do not like the answer, ah, I need a comment norms, for example, each class. M file is not required to explain the role of note, is not need to explain the usefulness of each method and whatwhatwhat so, expect answers

X �n X. . . . . Comment this thing. . Eyes of the beholder wise see wisdom, ah, you want to write more clearly also, absolutely can not write. . .

But if you say the words specification, reference Apple's official demo, then
1) Project which has readMe.txt, this is mainly introductory comments, version updates, ah, and explain the use of some important classes.
2). H front and. M generally have a large segment of useless responsibility statement or something, some little simple introduction. Not focus comment About readMe methods are lost in it.
3) "/ /", then simply use the comment in place, use a more flexible
4) # param mark the beginning of the content used in a large segment of segmentation and the method used above. On such
# Param mark UITableViewDelegate
.....
# Param mark UITableViewDataSource
...

This explains the above paragraph is about UITableViewDelegate agent inside the method, and then UITableViewDataSource is another proxy slightly.

Comment this thing do not be entangled -. . . Because the code does not require too many good comments, one can understand it.

Thank you,

To the point spread. .
Reply:

reference to the 10th floor yang8456211 reply:

Quote: references to the 9th floor yangfanacc reply:

Quote: references to the 7th floor yang8456211 reply:

Quote: references to the 6th floor yangfanacc reply:

Obviously I do not like the answer, ah, I need a comment norms, for example, each class. M file is not required to explain the role of note, is not need to explain the usefulness of each method and whatwhatwhat so, expect answers

X �n X. . . . . Comment this thing. . Eyes of the beholder wise see wisdom, ah, you want to write more clearly also, absolutely can not write. . .

But if you say the words specification, reference Apple's official demo, then
1) Project which has readMe.txt, this is mainly introductory comments, version updates, ah, and explain the use of some important classes.
2). H front and. M generally have a large segment of useless responsibility statement or something, some little simple introduction. Not focus comment About readMe methods are lost in it.
3) "/ /", then simply use the comment in place, use a more flexible
4) # param mark the beginning of the content used in a large segment of segmentation and the method used above. On such
# Param mark UITableViewDelegate
.....
# Param mark UITableViewDataSource
...

This explains the above paragraph is about UITableViewDelegate agent inside the method, and then UITableViewDataSource is another proxy slightly.

Comment this thing do not be entangled -. . . Because the code does not require too many good comments, one can understand it.

Thank you,

To the point spread. .

good, Thank you, gave you points,