有人愿意查看此 JS 代码以获取自定义滚动条吗？

Question

我绝不是程序员...我从来没有真正参加过 Comp sci 课程，不太了解理论，但我仍然将通常有效的代码组合在一起。我只是不知道它实际上有多丑。我最近写了这个（简单的）JS，想知道我能得到一些关于它的反馈......

如果这不是一个合适的地方，请告诉我。谢谢。

--会

    /*
    @author: Will Cavanagh
    @date: 2009-09-14
    * Custom scroll box
    */
    var customScroller = {
 intRegex : /^\d+$/,
 maxScroll : 0,
 inited : false,
 upColor : "#FFF",
 downColor : "#FFF", 
 defSpeed : "#FFF",

 //init function -- sets config values and initallizes jQuery slider.
 //@param options : object containing set up parameters
 //@return null
 init : function(options) {
  //if there are no options/colors specified, make empty object
  if(!options) { options = new Object(); };
  if(!options.scrollerColor) { options.scrollerColor = new Object(); };

  //assign variables, use defaults if not defined.
  var width = this.intRegex.test(options.width) ? options.width : 500
  var height = this.intRegex.test(options.height) ? options.height : 300;
  var vertical = options.vertical == null ? true : options.vertical;
  upColor = options.scrollerColor.upColor == null ? '#4a4a4a' : options.scrollerColor.upColor;
  downColor = options.scrollerColor.downColor == null ? '#333' : options.scrollerColor.downColor;
  var bkgdColor = options.scrollerColor.bkgdColor == null ? '#848484' : options.scrollerColor.bkgdColor;
  defSpeed = options.defaultSpeed == null ? '1000' : options.defaultSpeed;

  //set content width before measuring
  jQuery("#content-scroll").css({width: width});

  //get height of content, subtract height of pane to be shown in
  maxScroll = jQuery("#content-scroll").height() - height;
   //set the height of pane to hold content.  This is done after measuring content height for browser compatability reasons
  jQuery("#content-scroll").css({width: width, height: height});
  if(this.vertical) {
   var orientation = 'vertical';
  } else {
   var orientation = 'horizontal';
  }

  //create the JQuery.UI slider
  jQuery("#content-slider").slider({
   value: 100,
   orientation: 'vertical',
      animate: false,
     change: customScroller.handleSliderChange,
      slide: customScroller.handleSliderSlide,
     start: customScroller.handleSliderStart,
      stop: customScroller.handleSliderStop
     });

     jQuery(".ui-slider-handle").css({background:upColor});
     jQuery("#slider-bkg").css({background:bkgdColor});

     $("#content-scroll").mousewheel(function(objEvent, intDelta){
   scroll(intDelta * -30, 0);
  });

  inited = true;
 },

 //animates a scroll to the beginning of the content
 //@return null
 goTop : function() {
  if(!inited) { return };
  var scrollto = 0;
  jQuery("#content-scroll").animate({scrollTop: scrollto}, {queue:false, duration:defSpeed});
  jQuery("#content-slider").slider('option', 'value', 100*(1-(scrollto/maxScroll)));
 },


 //handler function bound to a slider change event.
 //@param e : event
 //@param ui : slider ui object
 //@return null
 handleSliderChange : function(e, ui) {
  if(!inited) { return };
  jQuery("#content-scroll").animate({scrollTop: ((100-ui.value) / 100) * (maxScroll) }, {queue:false, duration:defSpeed});
 },

 //handler function bound to a slider slide event.
 //@param e : event
 //@param ui : slider ui object
 //@return null
 handleSliderSlide : function(e, ui) {
  if(!inited) { return };
  jQuery("#content-scroll").attr({scrollTop: ((100-ui.value) / 100) * (maxScroll) });
 },

 //handler function bound to a slider start of slide event.
 //@return null
 handleSliderStart : function() {
  if(!inited) { return };
  jQuery(".ui-slider-handle").css({background:downColor});
 },

 //handler function bound to a slider end of slide event.
 //@return null
 handleSliderStop : function() {
  if(!inited) { return };
  jQuery(".ui-slider-handle").css({background:upColor});
 },


 //scroll by a given amount.
 //@param amt : amount to scroll by
 //@param speed : sroll animation speed, defaults to default speed defined in init params
 //@return null
 scroll : function(amt, speed) {
  if(!inited) { return };
  if(!speed) { speed = defSpeed; }
  var scrollto = jQuery("#content-scroll").scrollTop() + amt;
  if(scrollto > (maxScroll - 20)) scrollto = maxScroll; //near or past end of content, scroll to end
  if(scrollto < 20) scrollto = 0; //near or past beginning of content, scroll to beginning

  jQuery("#content-scroll").animate({scrollTop: scrollto}, {queue:false, duration:speed}); //animate content scroll
  jQuery("#content-slider").slider('option', 'value', 100*(1-(scrollto/maxScroll))); //update slider position
 }
    }

Answer 1

小贴士：

• new Object(); 可以安全地替换为对象文字 - { }。
• 语句后缺少一些引号（可能通过 JSLint 运行）。
• 您有未声明的变量，例如upColor 和 downColor。使用var 声明它们。
• “config”中只有一些值。为什么其余的都是内联的？
• 在您的示例 (scrollto < 20) 中，最好避免使用诸如 20 之类的“幻数”。在描述性名称下分别定义它们。
• 一些选择器字符串 - 例如“#content-scroll” - 在整个脚本中重复；最好将它们带入配置中（同时使事情更具可扩展性和 DRY）。
• 在这种情况下（options.scrollerColor.upColor == null）似乎没有必要与null 进行比较。我会放弃 null 并改用隐式类型转换（这也会捕获空字符串！）

Answer 2

除了 kangax 说的，这是定义默认值的有点笨拙的方法：

var width = this.intRegex.test(options.width) ? options.width : 500;
var height = this.intRegex.test(options.height) ? options.height : 300;
var vertical = options.vertical == null ? true : options.vertical;

更好的方法是使用 ||运营商：

var width = options.width || 500;
var height = options.height || 300;
var vertical = options.vertical || true;

一个更好的方法是一个函数，它接受一个带有默认选项的对象并将这些与实际提供的选项结合起来：

var defaultOptions = {width: 500, height: 300, vertical: true};
var options = applyDefaults(defaultOptions, options);

还有……

您可能需要考虑完全删除那些if(!inited) { return } 行，或者用if(!inited) { alert("not inited"); } 替换它们，否则您会掩盖错误。当有人尝试使用您的customScroller 但忘记运行init() 时，目前这件事不起作用，甚至没有给出错误，而且很难找出所有事情的原因默默地失败。最好在巨大的噪音中失败。

还有更多...

看来您确实需要考虑采用更加面向对象的方法。目前，您拥有所有这些全局变量 inited、upColor、downColor 等，它们真的非常想成为实例变量。说，像这样：

var CustomScroller = function(options) {
  this.options = options;
};
CustomScroller.prototype = {
  init: function() {
    ...
    this.inited = true;
  },
  goTop: function() {
    if (!this.inited) { alert("Not inited!"); }
    ...
  }
};

var myScroller = new CustomScroller({width: 100, height: 300, ...});
myScroller.init();
myScroller.goTop();

Answer 3

主要是，不要害怕空格。将块中的语句与表达式放在不同的行上可以更容易地查看表达式的结束位置和语句的开始位置。

示例：

if(expression) {
    statement;
}

对比

if(expression){ statement; }

另外，在块语句中始终使用括号也是一个好习惯，这样可以防止很多错误。

例子

if(expression) {
  statement;
  statement;
}

对比

if(expression) 
statement;
statement; //woops

你有很多 if-not-return 结构，其中 if-do 会更少行更清晰。

例子

if(!expression) {
  return;
}
statement;

对比

if(expression) {
  statement;
}