注释

只对存在一定业务逻辑复杂性的代码进行注释

注释并不是必须的，好的代码是能够让人一目了然，不用过多无谓的注释。

反例:

  1. function hashIt(data) {
  2.   // The hash
  3.   var hash = 0;
  5.   // Length of string
  6.   var length = data.length;
  8.   // Loop through every character in data
  9.   for (var i = 0; i < length; i++) {
  10.     // Get character code.
  11.     var char = data.charCodeAt(i);
  12.     // Make the hash
  13.     hash = ((hash << 5) - hash) + char;
  14.     // Convert to 32-bit integer
  15.     hash = hash & hash;
  16.   }
  17. }

正例:

  2. function hashIt(data) {
  3.   var hash = 0;
  4.   var length = data.length;
  6.   for (var i = 0; i < length; i++) {
  7.     var char = data.charCodeAt(i);
  8.     hash = ((hash << 5) - hash) + char;
  10.     // Convert to 32-bit integer
  11.     hash = hash & hash;
  12.   }
  13. }

不要在代码库中遗留被注释掉的代码

版本控制的存在是有原因的。让旧代码存在于你的 history 里吧。

反例:

  1. doStuff();
  2. // doOtherStuff();
  3. // doSomeMoreStuff();
  4. // doSoMuchStuff();

正例:

  1. doStuff();

不需要版本更新类型注释

记住，我们可以使用版本控制。废代码、被注释的代码及用注释记录代码中的版本更新说明都是没有必要的。

需要时可以使用 git log 获取历史版本。

反例:

  1. /**
  2.  * 2016-12-20: Removed monads, didn't understand them (RM)
  3.  * 2016-10-01: Improved using special monads (JP)
  4.  * 2016-02-03: Removed type-checking (LI)
  5.  * 2015-03-14: Added combine with type-checking (JR)
  6.  */
  7. function combine(a, b) {
  8.   return a + b;
  9. }

正例:

  1. function combine(a, b) {
  2.   return a + b;
  3. }

避免位置标记

这些东西通常只能代码麻烦，采用适当的缩进就可以了。

反例:

  1. ////////////////////////////////////////////////////////////////////////////////
  2. // Scope Model Instantiation
  3. ////////////////////////////////////////////////////////////////////////////////
  4. let $scope.model = {
  5.   menu: 'foo',
  6.   nav: 'bar'
  7. };
  9. ////////////////////////////////////////////////////////////////////////////////
  10. // Action setup
  11. ////////////////////////////////////////////////////////////////////////////////
  12. let actions = function() {
  13.   // ...
  14. }

正例:

  1. let $scope.model = {
  2.   menu: 'foo',
  3.   nav: 'bar'
  4. };
  6. let actions = function() {
  7.   // ...
  8. }

避免在源文件中写入法律评论

将你的 LICENSE 文件置于源码目录树的根目录。

反例:

  1. /*
  2. The MIT License (MIT)
  4. Copyright (c) 2016 Ryan McDermott
  6. Permission is hereby granted, free of charge, to any person obtaining a copy
  7. of this software and associated documentation files (the "Software"), to deal
  8. in the Software without restriction, including without limitation the rights
  9. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. copies of the Software, and to permit persons to whom the Software is
  11. furnished to do so, subject to the following conditions:
  13. The above copyright notice and this permission notice shall be included in all
  14. copies or substantial portions of the Software.
  16. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22. SOFTWARE
  23. */
  25. function calculateBill() {
  26.   // ...
  27. }

正例:

  1. function calculateBill() {
  2.   // ...
  3. }